mirror of
https://github.com/ChrisTitusTech/winutil.git
synced 2026-08-10 01:51:18 +10:00
Sean (ANGRYxScotsman)andGitHub
e96f990c60
* Fix the same arrow-icon alignment issue on the "Read the Docs" button
Same root cause as the hero/final-CTA buttons: the label was plain
markdown text, which MDX wrapped in a <p>, and the icon was missing
the size/nudge applied elsewhere. Match it to the other two buttons.
* Rename known-issues page slug to knownissues
Update the sidebar config, nav dropdown, and every internal link that
pointed at /known-issues/ to match.
* Fix image paths in root-level markdown to match the new docs site
The Hugo docs site (docs/assets/images/...) has been replaced by the
Astro site (docs/src/assets/...); update CONTRIBUTING.md,
READMEITALIAN.md, and README.md to point at the new asset locations.
* Remove unused houston.webp asset
Leftover Starlight default-theme asset with no references anywhere
in the docs site.
* Fix docs site reference in generator docs
Updates `tools/devdocs-generator.md` to describe link generation correctly: links now point to the Astro/Starlight documentation site instead of the old Hugo site.
* Point docs homepage CTAs to guides hub
Updates the docs landing page CTA links to use `/guides/` instead of `/guides/getting-started/` in the hero action and both “Get Started”/“Read the Docs” buttons, routing users to the guides index.
* Add reusable YouTube embeds to docs guides
Introduces a new `YouTubeEmbed.astro` component for responsive 16:9 video embeds using the privacy-enhanced `youtube-nocookie.com` domain. The User Guide index and Tweaks guide now import and use this component instead of plain YouTube links, and the component includes styling that overrides Starlight’s iframe reset so embedded videos render at the correct size.
* Fix YouTube embed iframe height via not-content
Add the `not-content` class to the embed wrapper so Starlight's markdown reset no longer overrides `iframe { height: auto }`. Drop the `@layer starlight.core` wrapper and `!important` overrides that were compensating for the same issue.
* Clarify docs comments across Astro components
Adds and refines inline comments in the docs site config, custom Starlight components, and theme styles to better explain layout structure, navigation dropdown behavior, hero composition, and theme initialization. Also normalizes a few multi-line comments into single-line form for readability without changing functionality.
* Set secondary docs button background color
Update `.wu-btn-secondary` in the docs theme to use `var(--sl-color-gray-6)` instead of a transparent background, improving button visibility and contrast while keeping existing border and hover behavior.
* Move User Guides into docs dropdown
Updates the docs header navigation so the “User Guides” link is grouped under the existing “Documentation” dropdown instead of appearing as a separate top-level nav item. This keeps related documentation links together and simplifies the top navigation.
* Fix hero margin and center trust section
Remove the automatic 1.5rem top margin Starlight adds between the hero and the content column. Also flex-center the trust section so its content is properly aligned.
* Disable edit links in generated dev docs
Update `tools/devdocs-generator.ps1` to include `editUrl: false` in the frontmatter for generated tweak and feature docs pages. This prevents Starlight from showing edit links on these auto-generated pages.
* Move docs update PRs to pre-release flow
The docs Pages workflow is simplified to only build and deploy the docs site: it now triggers only on docs changes, drops extra permissions/default shell settings, and removes the dev-docs generation + auto-PR steps. The pre-release workflow now owns that automation by expanding its PR step to include generated code-reference docs alongside JSON link updates, with updated commit/title/body text and a documentation label.
* Shorten generated docs source note
Simplify the autogenerated DevDocs notice so generated pages only warn against direct edits while still linking back to the source file.
* Improve docs header dropdown behavior
Reworked the header nav dropdown triggers to use native `<details>/<summary>` instead of buttons, then updated menu visibility logic to use `details[open]` for no-JS support on touch and keyboard while preserving hover behavior. Also renamed the “Developer Docs” link to “Code Reference” and tightened related CSS comments.
* Refresh contribution and docs workflow docs
Updated contributor-facing docs to use consistent Markdown admonition blocks, cleaned Mermaid fence formatting, and fixed minor wording/capitalization in contribution steps. Clarified `devdocs-generator` behavior so workflow ownership is explicit: generation now documented as part of `pre-release.yaml` (via docs-update PR), while `docs.yaml` is documented as build/deploy only.
* Fix contributing guide grammar
Correct the "it's" to "its" typo in both contributing guides so the pull request guidance is consistent across the GitHub and docs versions.
90 lines
4.9 KiB
Markdown
90 lines
4.9 KiB
Markdown
# Chris Titus Tech's Windows Utility
|
|
|
|
[](https://github.com/ChrisTitusTech/winutil/releases/latest)
|
|
|
|
[](https://discord.gg/RUbZUZyByQ)
|
|
|
|
A curated compilation of Windows system tasks streamline **installs**, debloat with **tweaks**, troubleshoot with **config**, and configure **Windows updates**. Run it fresh on every new Windows install.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
> **WinUtil must be run as Administrator** Because it performs system-wide changes.
|
|
|
|
Open PowerShell or Terminal as admin, then run:
|
|
|
|
**Stable Branch (recommended)**
|
|
```ps1
|
|
irm https://christitus.com/win | iex
|
|
```
|
|
|
|
**Development Branch**
|
|
```ps1
|
|
irm https://christitus.com/windev | iex
|
|
```
|
|
|
|
### How to open an admin terminal
|
|
|
|
- **Start menu:** Right-click Start → *Windows PowerShell (Admin)* or *Terminal (Admin)*
|
|
- **Search:** Press the `Windows key`, and type `PowerShell` or `Terminal`, then `Ctrl + Shift + Enter`
|
|
|
|
---
|
|
|
|
## Automation / Presets
|
|
|
|
Apply a predefined configuration without manual selection:
|
|
|
|
```powershell
|
|
& ([ScriptBlock]::Create((irm https://christitus.com/win))) -Preset Standard
|
|
```
|
|
|
|
| Preset | Description |
|
|
|--------|-------------|
|
|
| `Standard` | Balanced defaults for most users |
|
|
| `Minimal` | Minimal changes to suit every user |
|
|
| `Advanced` | Deep tweaks for power users |
|
|
|
|
To view exactly what each preset does, see:
|
|
https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json
|
|
|
|
---
|
|
|
|
## Build & Develop
|
|
|
|
See https://github.com/ChrisTitusTech/winutil/blob/main/.github/CONTRIBUTING.md
|
|
|
|
---
|
|
|
|
## Resources
|
|
|
|
- [Official Documentation](https://winutil.christitus.com/)
|
|
- [YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
|
- [ChrisTitus.com Article](https://christitus.com/windows-tool/)
|
|
- [Known Issues](https://winutil.christitus.com/knownissues/)
|
|
- [Report an Issue](https://github.com/ChrisTitusTech/winutil/issues)
|
|
|
|
---
|
|
|
|
## Support
|
|
|
|
- Leave a ⭐ to show support!
|
|
- EXE Wrapper for $10 @ https://www.cttstore.com/windows-toolbox
|
|
|
|
## Sponsors
|
|
|
|
These are the sponsors that help keep this project alive with monthly contributions.
|
|
|
|
<!-- sponsors --><a href="https://github.com/ysaito8015"><img src="https://github.com/ysaito8015.png" width="60px" alt="User avatar: Yusuke Saito" /></a><a href="https://github.com/dwelfusius"><img src="https://github.com/dwelfusius.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/mews-se"><img src="https://github.com/mews-se.png" width="60px" alt="User avatar: Martin" /></a><a href="https://github.com/jdiegmueller"><img src="https://github.com/jdiegmueller.png" width="60px" alt="User avatar: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https://github.com/robertsandrock.png" width="60px" alt="User avatar: RMS" /></a><a href="https://github.com/paulsheets"><img src="https://github.com/paulsheets.png" width="60px" alt="User avatar: Paul" /></a><a href="https://github.com/djones369"><img src="https://github.com/djones369.png" width="60px" alt="User avatar: Dave J (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https://github.com/anthonymendez.png" width="60px" alt="User avatar: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https://github.com/FatBastard0.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/DursleyGuy"><img src="https://github.com/DursleyGuy.png" width="60px" alt="User avatar: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https://github.com/DwayneTheRockLobster1.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/KieraKujisawa"><img src="https://github.com/KieraKujisawa.png" width="60px" alt="User avatar: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https://github.com/andrewpayne68.png" width="60px" alt="User avatar: Andrew P" /></a><a href="https://github.com/seanh1995"><img src="https://github.com/seanh1995.png" width="60px" alt="User avatar: Sean (ANGRYxScotsman)" /></a><a href="https://github.com/Abs313a"><img src="https://github.com/Abs313a.png" width="60px" alt="User avatar: Abs" /></a><!-- sponsors -->
|
|
|
|
---
|
|
|
|
## Contributors
|
|
|
|
[](https://github.com/ChrisTitusTech/winutil/graphs/contributors)
|
|
|
|
Thanks to everyone who has contributed time and effort to this project. Keep rocking 🍻
|