Compare commits

...
Author SHA1 Message Date
OmarandGitHub f7c072341d Fix USB creation when install.wim is read-only (#4910)
* fix: allow USB WIM splitting

* test: guard USB WIM splitting fix
2026-08-04 16:01:12 -05:00
FallenGMEandGitHub 32cc623959 Teamspeak6 Added (#4915)
TS 6 is obv. better than TS3
2026-08-04 16:00:19 -05:00
Sean (ANGRYxScotsman)andGitHub b096aaa5e5 Centralize agent instructions in SPEC (#4912)
* Centralize agent instructions in SPEC

Move the full coding-agent contract and repository guidance from `AGENTS.md` into `SPEC.md`, and reduce `AGENTS.md` to a simple pointer to the canonical instructions. Add lightweight `CLAUDE.md`, `GEMINI.md`, and `.github/copilot-instructions.md` files so different assistants consistently bootstrap through the same repo-specific guidance.

* Clarify auto-generated docs path scope in SPEC

Narrowed rule #3 to specify exact auto-generated subdirectories (tweaks/ and features/) rather than the entire code-reference/ directory, and clarified that other hand-written pages (e.g. architecture.mdx) may be edited directly.

* Remove archived docs from gitignore

Drop the old `docs-old` Hugo ignore rules from `.gitignore`, reflecting that the archived docs build artifacts no longer need special handling there.

* Add local env files to docs .gitignore

Add .env.local and .env.*.local patterns to prevent local environment files from being committed.

* Clarify test and git hygiene guidance

Update `SPEC.md` to run Pester in CI mode and tighten repository hygiene instructions around ignored files. The git guidance now points contributors to the actual `.gitignore` files and clarifies that `docs/public/` contains tracked static assets rather than generated output.

* Split agent workflow from project spec

Move repository working instructions into `AGENTS.md` and refocus `SPEC.md` on the stable WinUtil project contract. This separates agent-specific guidance from architecture, build, runtime, docs, testing, and release details so both documents have clearer ownership.

* docs: clarify Pester, ScriptAnalyzer, and source-of-truth rules

Expand AGENTS.md with context on why -SkipPublisherCheck is needed for Pester installation, why winutil.ps1 should be deleted before running ScriptAnalyzer, and clarify that the source-of-truth rule applies only to compiled-script behavior — repository metadata files are edited directly.

* Clarify Pester install command and -SkipPublisherCheck reason

Expands the explanation for why -SkipPublisherCheck is needed (catalog-signed vs Authenticode-signed), clarifies it does not skip download integrity, and adds -Repository PSGallery to pin the trusted source explicitly.
2026-08-04 15:29:49 -05:00
Chris TitusandGitHub a0142ace72 chore: Update generated dev docs and JSON links (#4909) 2026-08-03 19:12:47 -05:00
OmarandGitHub 97f2ad6e98 Fix windev prerelease version during elevation (#4908)
* Fix prerelease elevation cleanup

* Support restricted PowerShell in windev

* Use current PowerShell engine in windev
2026-08-03 19:10:49 -05:00
OmarandGitHub 97e0711034 Restore Document category and applications (#4902)
* feat: restore document category

Moves existing document-focused apps into the Document category and adds its filter chip.

* feat: restore document applications

Restores reviewed document-focused apps removed in PR #4451.

* chore: update apps list as per code review comments

This also updates the link for PDF24 Creator

* test: verify document category filter wiring

Covers the Document filter handler and config category presence.

* fix: categorize Calibre as multimedia

Keeps the e-book reader in Multimedia Tools.
2026-08-03 19:07:56 -05:00
OmarandGitHub b832da622f Restore native window animations and custom caption hit testing (#4888)
* feat: restore native window animations

* fix: disable native caption button hit testing

* test: remove fake window state assertions
2026-08-03 18:54:06 -05:00
Mohammad FaizandGitHub f7361fdb72 fix: repair popup install binding, dialog titles, presets switch, radio groups, JSON, tests (#4893)
* fix: repair popup install binding, dialog titles, presets switch, radio groups, JSON, tests

- Invoke-WPFInstall: add param block so the right-click app popup binds
  -PackagesToInstall. It previously dropped the argument into $args and
  installed the whole selected list instead of the clicked app (or warned
  that nothing was selected).
- Replace undefined $AppTitle with "WinUtil" in Install/UnInstall warning
  boxes, matching the XAML window title and sibling dialogs.
- tweaks.json: remove stray nested "link" inside the WPFToggleScrollbars
  registry entry (dead property; registry entries expose only the six
  consumed fields).
- Invoke-WPFPresets: fix dead switch cases to the wildcard-pattern
  convention so selectedFeatures/selectedToggles clear correctly.
- Invoke-WPFUIElements: store the group StackPanel in radioButtonGroups so
  grouped radio buttons share one container (else branch was unreachable).
- sanity.Tests.ps1: pass the Windows PowerShell parser script via
  -EncodedCommand; -Command string marshaling corrupted backticks/quotes and
  produced false parse failures.
- install-workflow.Tests.ps1: remove the AppTitle workaround and update
  title assertions to "WinUtil"; drop orphaned cleanup lines.
- Add CHANGES.md with technical and plain-language explanations.

Verified: each bug reproduced against HEAD, fixes demonstrated to change
behavior, full Pester suite 471/471.

* Delete

* test: cover the explicit popup install parameter path

Add a regression test invoking Invoke-WPFInstall -PackagesToInstall with a
package different from the default sync.selectedApps selection and assert
the runspace receives the explicit object, mirroring the Initialize-WPFUI
popup call shape. Existing default-path coverage is unchanged.
2026-08-03 12:03:03 -05:00
Sean (ANGRYxScotsman)andGitHub f3cf1587e0 Import YouTubeEmbed in tweaks guide (#4907)
Add the `YouTubeEmbed` component import to `docs/src/content/docs/guides/tweaks.mdx` so the guide can use embedded YouTube content without missing-component build issues.
2026-08-03 11:57:01 -05:00
91ffd3af30 Refactor UI checkbox and toggle state synchronization (#4885)
Co-authored-by: vyas-devgna <vyas-devgna@users.noreply.github.com>
2026-08-03 11:38:26 -05:00
Sean (ANGRYxScotsman)andGitHub 1ef581026f Fix image paths in GitHub markdown docs (#4905)
Update image links in `.github/CONTRIBUTING.md` and `.github/READMEITALIAN.md` from `../docs/...` to `/docs/...` so screenshots resolve correctly when viewed from the `.github` directory context on GitHub.
2026-08-03 11:37:32 -05:00
Sean (ANGRYxScotsman)andGitHub 89fd09fc0e fix(docs): add mobile navigation to the splash homepage (#4904)
The homepage uses Starlight's splash template, which has no sidebar and
therefore never gets Starlight's own mobile menu toggle - on narrow
viewports there was no way to reach any nav link at all. Add a small
toggle + panel in the header (only rendered on pages without a sidebar)
exposing the same links as the desktop nav, and group it with the
search icon so mobile actions sit together instead of spread across
the header.

Also add the Store and Forums links to the real sidebar config so
they're reachable on mobile on every other page too (previously only
in the desktop-only top nav), and pull both URLs from a shared
site-links.ts so the sidebar config and header can't drift apart.
2026-08-03 11:36:46 -05:00
056a819470 Refresh Applications tab screenshots and reorder docs to match the app (#4903)
* Update Applications tab screenshots

Replace outdated install/uninstall/show-installed screenshots and add
new ones for upgrade-all, clear-selection, selected-apps counter, and
collapse/expand categories.

* Update Applications guide with new screenshots and sections

Point each tab at its refreshed screenshot, reorder tabs to match the
sidebar button order in the app, and document the Upgrade All,
Selected Apps counter, and Collapse/Expand Categories controls.

* Add missing Updates tab screenshot

The image was referenced by the Updates guide but was never checked
into the repo.

* Reorder screenshots to follow their intro paragraph

Move the tab screenshot below the introductory text on the Tweaks and
Updates guide pages, matching the paragraph-then-screenshot layout
used elsewhere in the docs.

---------

Co-authored-by: Chris Titus <contact@christitus.com>
2026-08-03 11:36:03 -05:00
Sean (ANGRYxScotsman)andGitHub e96f990c60 Fix alignment issues, update links, and enhance documentation (#4898)
* 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.
2026-08-03 10:23:31 -05:00
Chris TitusandGitHub e591161dac Update sponsors in README (#4900) 2026-08-01 10:46:40 -05:00
Chris TitusandGitHub d98f8a9916 Update README.md 2026-07-31 15:32:15 -05:00
158 changed files with 894 additions and 469 deletions
+33 -38
View File
@@ -5,13 +5,13 @@
* Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil! * Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!
#### **Run the latest pre-release** #### **Run the latest pre-release**
```ps1
irm https://christitus.com/windev | iex
```
!!! bug "Keep in mind" ```ps1
irm https://christitus.com/windev | iex
```
This is a pre-release and should be treated as such. It exists for developers to test the utility and report or fix bugs before they get added to the stable release. Don't use it in production! > [!CAUTION]
> **Keep in mind:** This is a pre-release and should be treated as such. It exists for developers to test the utility and report or fix bugs before they get added to the stable release. Don't use it in production!
## Issues ## Issues
@@ -23,19 +23,17 @@
* If you're doing code changes, then you can submit a PR to the `main` branch. * If you're doing code changes, then you can submit a PR to the `main` branch.
!!! warning "Important" > [!IMPORTANT]
> Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE ITS OWN PULL REQUEST!
Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE IT'S OWN PULL REQUEST! >
> Do not open a pull request that adds support for other languages to WinUtil for now, until we decide how we want to move forward with language support.
Do not open a pull request that adds support for other languages to WinUtil for now, until we decide how we want to move forward with language support.
* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but is not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes. Document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in the denial of the pull request. Additionally, any code lacking sufficient documentation may also be denied. * When creating pull requests, it is essential to thoroughly document all changes made. This includes, but is not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes. Document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in the denial of the pull request. Additionally, any code lacking sufficient documentation may also be denied.
* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented. * By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
!!! note > [!NOTE]
> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
## Walk through ## Walk through
@@ -47,37 +45,34 @@
### Overview ### Overview
``` mermaid ```mermaid
%%{init: {"flowchart": {"curve": "cardinal"}} }%% %%{init: {"flowchart": {"curve": "cardinal"}} }%%
graph TD graph TD
  A[Fork Project] --> B[Clone Repository]; A[Fork Project] --> B[Clone Repository];
  B --> C[Create New Branch]; B --> C[Create New Branch];
  C --> D[Make Changes]; C --> D[Make Changes];
  D --> G[Test Changes]; D --> G[Test Changes];
  G --> H{Tests Passed?}; G --> H{Tests Passed?};
  H -->|Yes| E[Commit Changes]; H -->|Yes| E[Commit Changes];
  H -->|No| J[Fix Issues]; H -->|No| J[Fix Issues];
  J --> G; J --> G;
  E --> F[Push Branch]; E --> F[Push Branch];
  F --> K[Create Pull Request]; F --> K[Create Pull Request];
  K --> L[Fill out PR template]; K --> L[Fill out PR template];
classDef default stroke:#333,stroke-width:4px,font-size:12pt; classDef default stroke:#333,stroke-width:4px,font-size:12pt;
``` ```
!!! info
This is a diagram to guide you through the process. It may vary depending on the type of change you're making. > [!NOTE]
> This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
### Fork the Repo ### Fork the Repo
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list. * Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
![Fork Image](/docs/assets/images/Fork-Button-Dark.png#gh-dark-mode-only) ![Fork Image](/docs/src/assets/contributing/Fork-Button-Dark.png)
![Fork Image](/docs/assets/images/Fork-Button-Light.png#only-light#gh-light-mode-only)
### Clone the Fork ### Clone the Fork
!!! tip > [!TIP]
> While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.
While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.
* Install GitHub Desktop if it is not already installed. * Install GitHub Desktop if it is not already installed.
* Log in using the same GitHub account you used to fork WinUtil. * Log in using the same GitHub account you used to fork WinUtil.
@@ -96,7 +91,7 @@ graph TD
* Run the following command to compile and run WinUtil: * Run the following command to compile and run WinUtil:
* `.\Compile.ps1 -run` * `.\Compile.ps1 -run`
![Compile](/docs/assets/images/Complie.png) ![Compile](/docs/src/assets/contributing/Complie.png)
Open PowerShell as Administrator. Open PowerShell as Administrator.
@@ -107,15 +102,15 @@ Open PowerShell as Administrator.
### Committing the changes ### Committing the changes
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following: * Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
![Push Commit Image](/docs/assets/images/Discard-GHD.png) ![Push Commit Image](/docs/src/assets/contributing/Discard-GHD.png)
* Now, commit your changes once you are happy with the result. * Now, commit your changes once you are happy with the result.
![Commit Image](/docs/assets/images/Commit-GHD.png) ![Commit Image](/docs/src/assets/contributing/Commit-GHD.png)
* Push the changes to upload them to your fork on github.com. * Push the changes to upload them to your fork on GitHub.
![Push Commit Image](/docs/assets/images/Push-Commit.png) ![Push Commit Image](/docs/src/assets/contributing/Push-Commit.png)
### Making a PR ### Making a PR
* To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is no WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build. * To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is no WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build.
+1 -1
View File
@@ -7,7 +7,7 @@
Questa utility è una raccolta di attività Windows che eseguo personalmente su ogni sistema che utilizzo. È progettata per snellire le *installazioni*, rimuovere i componenti superflui tramite *ottimizzazioni*, risolvere problemi tramite la *configurazione*, e riparare *aggiornamenti* di Windows. Sono estremamente selettivo riguardo ai contributi per mantenere questo progetto pulito ed efficiente. Questa utility è una raccolta di attività Windows che eseguo personalmente su ogni sistema che utilizzo. È progettata per snellire le *installazioni*, rimuovere i componenti superflui tramite *ottimizzazioni*, risolvere problemi tramite la *configurazione*, e riparare *aggiornamenti* di Windows. Sono estremamente selettivo riguardo ai contributi per mantenere questo progetto pulito ed efficiente.
![screen-install](/docs/assets/images/Title-Screen.png) ![screen-install](/docs/src/assets/branding/title-screen.png)
## 💡 Come usarlo ## 💡 Come usarlo
+3
View File
@@ -0,0 +1,3 @@
# Copilot Instructions
Read `AGENTS.md` in the repository root for operating instructions before doing anything else.
-38
View File
@@ -6,25 +6,17 @@ on:
- main - main
paths: paths:
- "docs/**" - "docs/**"
- "config/tweaks.json"
- "config/feature.json"
- "functions/**"
workflow_dispatch: workflow_dispatch:
permissions: permissions:
contents: read contents: read
pages: write pages: write
id-token: write id-token: write
pull-requests: write
concurrency: concurrency:
group: "pages" group: "pages"
cancel-in-progress: false cancel-in-progress: false
defaults:
run:
shell: bash
jobs: jobs:
build: build:
if: github.repository == 'ChrisTitusTech/winutil' if: github.repository == 'ChrisTitusTech/winutil'
@@ -38,36 +30,6 @@ jobs:
fetch-depth: 0 fetch-depth: 0
persist-credentials: false persist-credentials: false
- name: Generate Dev Docs from JSON
shell: pwsh
run: |
Set-Location tools
./devdocs-generator.ps1
- name: Create Pull Request
id: cpr
uses: peter-evans/create-pull-request@v8
with:
token: ${{ secrets.AUTO_MERGE }}
commit-message: 'chore: Update generated dev docs'
title: 'chore: Update Generated Dev Docs'
body: 'Automated update of generated documentation from JSON sources'
branch: docs-update
delete-branch: true
add-paths: |
docs/src/content/docs/code-reference/
config/tweaks.json
config/feature.json
labels: |
automated
documentation
skip-changelog
- name: Check outputs
run: |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
- name: Install, build, and upload your site - name: Install, build, and upload your site
uses: withastro/action@v6 uses: withastro/action@v6
with: with:
+6 -4
View File
@@ -31,21 +31,23 @@ jobs:
Set-ExecutionPolicy Bypass -Scope Process -Force; ./Compile.ps1 Set-ExecutionPolicy Bypass -Scope Process -Force; ./Compile.ps1
continue-on-error: false # Directly fail the job on error, removing the need for a separate check continue-on-error: false # Directly fail the job on error, removing the need for a separate check
- name: Create Pull Request for Updated JSON Links - name: Create Pull Request for Updated Docs and JSON Links
id: cpr id: cpr
uses: peter-evans/create-pull-request@v8 uses: peter-evans/create-pull-request@v8
with: with:
token: ${{ secrets.AUTO_MERGE }} token: ${{ secrets.AUTO_MERGE }}
commit-message: 'chore: Update documentation links in JSON configs' commit-message: 'chore: Update generated dev docs and JSON links'
title: 'chore: Update documentation links in JSON configs' title: 'chore: Update generated dev docs and JSON links'
body: 'Automated update of documentation links in JSON configs from pre-release build' body: 'Automated update of generated documentation and JSON config links from pre-release build'
branch: docs-update branch: docs-update
delete-branch: true delete-branch: true
add-paths: | add-paths: |
docs/src/content/docs/code-reference/
config/tweaks.json config/tweaks.json
config/feature.json config/feature.json
labels: | labels: |
automated automated
documentation
skip-changelog skip-changelog
- name: Check outputs - name: Check outputs
-5
View File
@@ -13,8 +13,3 @@ desktop.ini
.vscode/ .vscode/
.idea/ .idea/
# hugo files (archived docs)
docs-old/public/
docs-old/.hugo_build.lock
docs-old/resources/
+47 -71
View File
@@ -4,35 +4,22 @@ Drop-in operating instructions for coding agents. Read this file before every ta
**Working code only. Finish the job. Plausibility is not correctness.** **Working code only. Finish the job. Plausibility is not correctness.**
This repository follows the AGENTS.md convention: these instructions are for Codex, Claude Code, Cursor, Windsurf, Copilot, Aider, Devin, Amp, and other coding agents that read `AGENTS.md`. `SPEC.md` in the repository root is the project contract — read it for what WinUtil is and how it's architected. This file covers how to work on it.
## 0. Non-Negotiables ## 0. Non-Negotiables
These rules override everything else in this file when in conflict: These rules override everything else in this file when in conflict:
1. **Do not edit `winutil.ps1` directly.** It is generated build output. Change source files and compile. 1. **Do not edit `winutil.ps1` directly.** It is generated build output (see SPEC.md's Build Model). Change source files and compile.
2. **Do not commit `winutil.ps1`.** It is ignored locally and generated by GitHub Actions for releases. 2. **Do not commit `winutil.ps1`.** It is ignored locally and generated by GitHub Actions for releases.
3. **Never fabricate.** Do not invent file paths, function names, command output, test results, commit hashes, or API behavior. Read the file or run the command. 3. **Never touch `docs/src/content/docs/code-reference/tweaks/` or `docs/src/content/docs/code-reference/features/`.** Both are auto-generated (see SPEC.md's Docs Site). Edit the source JSON (`config/tweaks.json`, `config/feature.json`) or the relevant PowerShell function file instead. Other hand-written pages under `code-reference/` (e.g. `architecture.mdx`) are not touched by the generator and may be edited directly.
4. **Disagree when the premise is wrong.** Say what is wrong before acting on it. 4. **Never fabricate.** Do not invent file paths, function names, command output, test results, commit hashes, or API behavior. Read the file or run the command.
5. **Stop when genuinely ambiguous.** If two interpretations would produce materially different diffs, ask before editing. 5. **Disagree when the premise is wrong.** Say what is wrong before acting on it.
6. **Touch only what the task requires.** No drive-by refactors, formatting sweeps, or unrelated cleanup. 6. **Stop when genuinely ambiguous.** If two interpretations would produce materially different diffs, ask before editing.
7. **Verify before saying done.** A plausible-looking diff is not proof. 7. **Touch only what the task requires.** No drive-by refactors, formatting sweeps, or unrelated cleanup.
8. **Verify before saying done.** A plausible-looking diff is not proof.
## 1. Project Context ## 1. Key Commands
WinUtil is a Windows PowerShell utility with a WPF interface. The repository is maintained as modular source, but the distributed artifact is one compiled PowerShell script.
### Stack
- Language: Windows PowerShell / PowerShell.
- UI: WPF via `xaml/inputXML.xaml`.
- Configuration: JSON files under `config/`.
- Tests: Pester tests under `pester/`.
- Lint: PowerShell Script Analyzer with settings in `lint/PSScriptAnalyser.ps1`.
- Docs: Hugo site under `docs/`.
- Release artifact: generated root `winutil.ps1`.
### Key Commands
- Compile: - Compile:
```powershell ```powershell
@@ -42,50 +29,38 @@ WinUtil is a Windows PowerShell utility with a WPF interface. The repository is
```powershell ```powershell
.\Compile.ps1 -Run .\Compile.ps1 -Run
``` ```
- Install the supported Pester version (one-time). `-SkipPublisherCheck` is required because Windows ships an inbox Pester 3.4.0 that is catalog-signed, and PowerShell Gallery's Pester 5.8.0 is Authenticode-signed — `Install-Module` refuses the upgrade without it. This does not skip download integrity (still HTTPS + NuGet package hash verification); `-Repository PSGallery` pins the trusted source explicitly rather than relying on whatever repositories happen to be registered:
```powershell
Install-Module -Name Pester -RequiredVersion 5.8.0 -Repository PSGallery -Scope CurrentUser -Force -SkipPublisherCheck
```
- Run tests: - Run tests:
```powershell ```powershell
Import-Module Pester -RequiredVersion 5.8.0 -Force Import-Module Pester -RequiredVersion 5.8.0 -Force
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI
``` ```
- Run Script Analyzer with project settings when available: - Run Script Analyzer with project settings when available. If a locally compiled `winutil.ps1` exists, delete it first — `lint/PSScriptAnalyser.ps1` only excludes rules, not files, so `-Recurse` would also lint the generated script and produce noise against line numbers that don't map to any source file:
```powershell ```powershell
Invoke-ScriptAnalyzer -Path . -Settings .\lint\PSScriptAnalyser.ps1 -Recurse Invoke-ScriptAnalyzer -Path . -Settings .\lint\PSScriptAnalyser.ps1 -Recurse
``` ```
- Docs site dev server (run from `docs/`):
```powershell
npm install
npm run dev
```
- Docs site production build (run from `docs/`):
```powershell
npm run build
```
Prefer the narrowest useful verification while iterating. Use the full relevant check before finishing. Prefer the narrowest useful verification while iterating. Use the full relevant check before finishing.
## 2. Source Of Truth ## 2. Source Of Truth
Make durable changes only in files consumed by `Compile.ps1` or in documentation/test files: For changes that affect the compiled WinUtil script, make them only in the source files described in SPEC.md's Repository Layout — never in `winutil.ps1` itself. If behavior changes require the compiled script to change, update the source files and run `.\Compile.ps1` only to verify generation.
- `scripts/start.ps1` for startup/bootstrap code. This scoping applies to compiled-script behavior only. Repository metadata — `AGENTS.md`, `SPEC.md`, `CLAUDE.md`/`GEMINI.md`/`.github/copilot-instructions.md`, `.github/workflows/`, and the root `.gitignore` — is edited directly when a task requires it, per the other sections of this file.
- `functions/public/*.ps1` for UI-facing and user-facing workflows.
- `functions/private/*.ps1` for internal helpers.
- `config/*.json` for applications, tweaks, features, DNS, presets, navigation, themes, and related declarative data.
- `xaml/inputXML.xaml` for the WPF UI layout.
- `tools/autounattend.xml` for the embedded unattended Windows setup template.
- `scripts/main.ps1` for the final entrypoint and GUI initialization logic appended during compile.
- `pester/*.Tests.ps1` for automated checks.
- `docs/` for Hugo documentation.
If behavior changes require the compiled script to change, update these source files and run `.\Compile.ps1` only to verify generation. ## 3. Before Editing
## 3. Build Model
`Compile.ps1` combines the repository sources into `winutil.ps1` in this order:
1. Read `scripts/start.ps1` and replace `#{replaceme}` with the current `yy.MM.dd` build date.
2. Append every file under `functions/` recursively.
3. Convert each `config/*.json` file into embedded `$sync.configs` objects.
4. Special-case `config/applications.json` so keys receive the `WPFInstall` prefix in compiled config.
5. Embed `xaml/inputXML.xaml` into `$inputXML`.
6. Embed `tools/autounattend.xml` into `$WinUtilAutounattendXml`.
7. Append `scripts/main.ps1`.
8. Write the result to root `winutil.ps1`.
Because the final script is concatenated, do not rely on runtime module imports or source-relative dot-sourcing unless the compiled script will also contain the required code/data.
## 4. Before Editing
- State the plan in one or two sentences before editing. For non-trivial work, include the verification you intend to run. - State the plan in one or two sentences before editing. For non-trivial work, include the verification you intend to run.
- Read the files you will touch and the files that call them. - Read the files you will touch and the files that call them.
@@ -93,30 +68,29 @@ Because the final script is concatenated, do not rely on runtime module imports
- Surface assumptions when they affect behavior, compatibility, or user data. - Surface assumptions when they affect behavior, compatibility, or user data.
- If two approaches have meaningful tradeoffs, name them before choosing. Trivial tasks can proceed directly. - If two approaches have meaningful tradeoffs, name them before choosing. Trivial tasks can proceed directly.
## 5. Coding Guidelines ## 4. Coding Guidelines
- Prefer the minimum code that solves the stated problem. - Prefer the minimum code that solves the stated problem.
- Keep PowerShell functions in one function file when practical, with the file name matching the primary function name. - Keep PowerShell functions in one function file when practical, with the file name matching the primary function name.
- Use approved PowerShell verb-noun names and follow the existing `WPF` / `WinUtil` naming conventions. - Use approved PowerShell verb-noun names and follow the existing `WPF` / `WinUtil` naming conventions; keep UI event handler names aligned with XAML element names per SPEC.md's UI And Event Contract.
- Keep UI event handler names aligned with XAML element names. A button named `WPFExampleButton` is typically handled by `Invoke-WPFExampleButton`. - Use `$sync` for shared state and UI references, consistent with SPEC.md's Runtime Model.
- Use `$sync` for shared state and UI references, consistent with the existing runspace model.
- Update WPF controls through the UI dispatcher when running work in a background runspace. - Update WPF controls through the UI dispatcher when running work in a background runspace.
- Keep config-driven features in JSON when they fit the existing schema instead of hard-coding lists in PowerShell. - Keep config-driven features in JSON when they fit the existing schema instead of hard-coding lists in PowerShell; follow SPEC.md's Configuration Contract for required fields and key-renaming rules.
- Preserve undo/original-state data for tweaks so users can reverse changes. - Preserve undo/original-state data for tweaks so users can reverse changes.
- Do not add abstractions, configurability, hooks, or "future extensibility" unless the task needs them now. - Do not add abstractions, configurability, hooks, or "future extensibility" unless the task needs them now.
- Clean up orphans created by your own changes, such as unused variables or functions made obsolete by the edit. - Clean up orphans created by your own changes, such as unused variables or functions made obsolete by the edit.
- Avoid broad formatting-only edits, especially in JSON config files, XAML, docs, and generated output. - Avoid broad formatting-only edits, especially in JSON config files, XAML, docs, and generated output.
## 6. Runtime And Safety Rules ## 5. Runtime And Safety Rules
- WinUtil performs system-level Windows changes. Treat registry, services, AppX removal, package manager, Windows Update, ISO, and unattended setup changes as high-risk. - WinUtil performs system-level Windows changes; treat registry, services, AppX removal, package manager, Windows Update, ISO, and unattended setup changes as high-risk (see SPEC.md's Safety Requirements).
- Prefer existing helper functions for WinGet, Chocolatey, registry, services, progress, and UI updates. - Prefer existing helper functions for WinGet, Chocolatey, registry, services, progress, and UI updates.
- Keep tweaks reversible where the schema supports it by including original values or original states. - Keep tweaks reversible where the schema supports it by including original values or original states.
- Never modify a user's original ISO in-place; follow existing copy/mount/export patterns. - Never modify a user's original ISO in-place; follow existing copy/mount/export patterns.
- Avoid storing credentials, secrets, or machine-specific paths in repo files. - Avoid storing credentials, secrets, or machine-specific paths in repo files.
- Preserve logging and user feedback patterns for long-running or destructive operations. - Preserve logging and user feedback patterns for long-running or destructive operations.
## 7. Surgical Changes ## 6. Surgical Changes
- Do not improve adjacent code, comments, formatting, imports, or docs unless required. - Do not improve adjacent code, comments, formatting, imports, or docs unless required.
- Do not refactor working code because you are already in the file. - Do not refactor working code because you are already in the file.
@@ -124,7 +98,7 @@ Because the final script is concatenated, do not rely on runtime module imports
- Keep diffs reviewable. Every changed line should trace to the user's request. - Keep diffs reviewable. Every changed line should trace to the user's request.
- If a change starts spreading across unrelated areas, pause and reassess the plan. - If a change starts spreading across unrelated areas, pause and reassess the plan.
## 8. Verification ## 7. Verification
Define success in terms that can be checked, then check it. Define success in terms that can be checked, then check it.
@@ -136,26 +110,28 @@ Define success in terms that can be checked, then check it.
- Read command output. Do not report tests as passing unless they actually passed. - Read command output. Do not report tests as passing unless they actually passed.
- If verification fails, fix the cause rather than weakening the test. - If verification fails, fix the cause rather than weakening the test.
If a check cannot be run, say exactly why and what residual risk remains. If a check cannot be run, say exactly why and what residual risk remains. See SPEC.md's Testing And CI for what GitHub Actions runs on every push.
## 9. Generated Files And Git Hygiene ## 8. Generated Files And Git Hygiene
- Treat local `winutil.ps1` changes as disposable compile output. - Treat local `winutil.ps1` changes as disposable compile output.
- Never stage or commit `winutil.ps1`, `docs/public/`, `docs/resources/`, `binary/`, editor folders, or other ignored build artifacts. - Never stage or commit `winutil.ps1`, `binary/`, or anything else ignored by the root `.gitignore` or `docs/.gitignore` — read those files rather than assuming. `docs/public/` is tracked source for static assets, not generated output.
- Do not remove `.gitignore` rules that keep generated artifacts out of Git. - Do not remove `.gitignore` rules that keep generated artifacts out of Git.
- Before finishing, check `git status --short` and separate your changes from pre-existing user changes. - Before finishing, check `git status --short` and separate your changes from pre-existing user changes.
- Do not revert user changes unless explicitly asked. - Do not revert user changes unless explicitly asked.
- Commit messages, when requested, should be descriptive: short subject under 72 characters, body explaining why when needed. - Commit messages, when requested, should be descriptive: short subject under 72 characters, body explaining why when needed.
- When committing, split changes into small, logical commits rather than one large commit, so each commit's diff is reviewable as a single group of related changes.
## 10. Documentation Expectations ## 9. Documentation Expectations
- Update `docs/content/` when user-facing behavior changes. - Update `docs/src/content/docs/guides/` when user-facing behavior changes.
- Update developer docs when architecture, build flow, config schema, or contribution workflow changes. - Update `docs/src/content/docs/code-reference/architecture.mdx` and other hand-written developer docs when architecture, build flow, config schema, or contribution workflow changes — but never hand-edit the auto-generated `code-reference/tweaks/` or `code-reference/features/` subfolders (see Non-Negotiables).
- Keep sidebar entries in `docs/astro.config.mjs` in sync with page slugs (see SPEC.md's Docs Site).
- Keep README changes brief and high-level. - Keep README changes brief and high-level.
- Put detailed user and developer documentation under `docs/`. - Put detailed user and developer documentation under `docs/`.
- Keep `SPEC.md` aligned with build/runtime contract changes. - Keep SPEC.md aligned with project/architecture changes, and this file aligned with process changes.
## 11. Communication Style ## 10. Communication Style
- Be direct and concise. Start with the answer or action. - Be direct and concise. Start with the answer or action.
- No flattery, filler, ceremonial closings, or fake certainty. - No flattery, filler, ceremonial closings, or fake certainty.
@@ -163,7 +139,7 @@ If a check cannot be run, say exactly why and what residual risk remains.
- Report what changed, how it was verified, and anything not done. - Report what changed, how it was verified, and anything not done.
- If the user asks for a review, lead with findings and file/line references. - If the user asks for a review, lead with findings and file/line references.
## 12. When To Ask ## 11. When To Ask
Ask before proceeding when: Ask before proceeding when:
@@ -178,7 +154,7 @@ Proceed without asking when:
- Ambiguity can be resolved by reading the code or running a local command. - Ambiguity can be resolved by reading the code or running a local command.
- The user already answered the question in this session. - The user already answered the question in this session.
## 13. Project Learnings ## 12. Project Learnings
When the user corrects an agent approach, add or tighten one concrete rule here before ending the session. Keep this section short and prune rules that no longer matter. When the user corrects an agent approach, add or tighten one concrete rule here before ending the session. Keep this section short and prune rules that no longer matter.
+3
View File
@@ -0,0 +1,3 @@
# CLAUDE.md
Read `AGENTS.md` in this repository root for operating instructions before doing anything else.
+3
View File
@@ -0,0 +1,3 @@
# GEMINI.md
Read `AGENTS.md` in the repository root for operating instructions before doing anything else.
+3 -2
View File
@@ -6,7 +6,8 @@
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. 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.
![Title Screen](/docs/assets/images/Title-Screen.png) ![Title Screen](docs/src/assets/branding/title-screen.png)
--- ---
@@ -77,7 +78,7 @@ See https://github.com/ChrisTitusTech/winutil/blob/main/.github/CONTRIBUTING.md
These are the sponsors that help keep this project alive with monthly contributions. These are the sponsors that help keep this project alive with monthly contributions.
<!-- sponsors --><a href="https://github.com/ysaito8015"><img src="https:&#x2F;&#x2F;github.com&#x2F;ysaito8015.png" width="60px" alt="User avatar: Yusuke Saito" /></a><a href="https://github.com/dwelfusius"><img src="https:&#x2F;&#x2F;github.com&#x2F;dwelfusius.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/mews-se"><img src="https:&#x2F;&#x2F;github.com&#x2F;mews-se.png" width="60px" alt="User avatar: Martin Stockzell" /></a><a href="https://github.com/jdiegmueller"><img src="https:&#x2F;&#x2F;github.com&#x2F;jdiegmueller.png" width="60px" alt="User avatar: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https:&#x2F;&#x2F;github.com&#x2F;robertsandrock.png" width="60px" alt="User avatar: RMS" /></a><a href="https://github.com/paulsheets"><img src="https:&#x2F;&#x2F;github.com&#x2F;paulsheets.png" width="60px" alt="User avatar: Paul" /></a><a href="https://github.com/djones369"><img src="https:&#x2F;&#x2F;github.com&#x2F;djones369.png" width="60px" alt="User avatar: Dave J (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https:&#x2F;&#x2F;github.com&#x2F;anthonymendez.png" width="60px" alt="User avatar: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https:&#x2F;&#x2F;github.com&#x2F;FatBastard0.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/DursleyGuy"><img src="https:&#x2F;&#x2F;github.com&#x2F;DursleyGuy.png" width="60px" alt="User avatar: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https:&#x2F;&#x2F;github.com&#x2F;DwayneTheRockLobster1.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/KieraKujisawa"><img src="https:&#x2F;&#x2F;github.com&#x2F;KieraKujisawa.png" width="60px" alt="User avatar: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https:&#x2F;&#x2F;github.com&#x2F;andrewpayne68.png" width="60px" alt="User avatar: Andrew P" /></a><a href="https://github.com/seanh1995"><img src="https:&#x2F;&#x2F;github.com&#x2F;seanh1995.png" width="60px" alt="User avatar: Sean (ANGRYxScotsman)" /></a><a href="https://github.com/Abs313a"><img src="https:&#x2F;&#x2F;github.com&#x2F;Abs313a.png" width="60px" alt="User avatar: Abs" /></a><!-- sponsors --> <!-- sponsors --><a href="https://github.com/ysaito8015"><img src="https:&#x2F;&#x2F;github.com&#x2F;ysaito8015.png" width="60px" alt="User avatar: Yusuke Saito" /></a><a href="https://github.com/dwelfusius"><img src="https:&#x2F;&#x2F;github.com&#x2F;dwelfusius.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/mews-se"><img src="https:&#x2F;&#x2F;github.com&#x2F;mews-se.png" width="60px" alt="User avatar: Martin" /></a><a href="https://github.com/jdiegmueller"><img src="https:&#x2F;&#x2F;github.com&#x2F;jdiegmueller.png" width="60px" alt="User avatar: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https:&#x2F;&#x2F;github.com&#x2F;robertsandrock.png" width="60px" alt="User avatar: RMS" /></a><a href="https://github.com/paulsheets"><img src="https:&#x2F;&#x2F;github.com&#x2F;paulsheets.png" width="60px" alt="User avatar: Paul" /></a><a href="https://github.com/djones369"><img src="https:&#x2F;&#x2F;github.com&#x2F;djones369.png" width="60px" alt="User avatar: Dave J (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https:&#x2F;&#x2F;github.com&#x2F;anthonymendez.png" width="60px" alt="User avatar: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https:&#x2F;&#x2F;github.com&#x2F;FatBastard0.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/DursleyGuy"><img src="https:&#x2F;&#x2F;github.com&#x2F;DursleyGuy.png" width="60px" alt="User avatar: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https:&#x2F;&#x2F;github.com&#x2F;DwayneTheRockLobster1.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/KieraKujisawa"><img src="https:&#x2F;&#x2F;github.com&#x2F;KieraKujisawa.png" width="60px" alt="User avatar: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https:&#x2F;&#x2F;github.com&#x2F;andrewpayne68.png" width="60px" alt="User avatar: Andrew P" /></a><a href="https://github.com/seanh1995"><img src="https:&#x2F;&#x2F;github.com&#x2F;seanh1995.png" width="60px" alt="User avatar: Sean (ANGRYxScotsman)" /></a><a href="https://github.com/Abs313a"><img src="https:&#x2F;&#x2F;github.com&#x2F;Abs313a.png" width="60px" alt="User avatar: Abs" /></a><!-- sponsors -->
--- ---
+64 -58
View File
@@ -1,10 +1,37 @@
# SPEC.md # SPEC.md
## Project Contract Project contract for WinUtil — what the project is, how it's built, and how it runs. Written for anyone, human or AI, who needs to understand the project itself.
WinUtil is a Windows PowerShell utility with a WPF interface. The repository is maintained as modular source files, but the released artifact is a single generated `winutil.ps1` script. `AGENTS.md` in the repository root points here for these facts, and separately covers how an agent should behave while working in this repo. This file does not change based on who's reading it.
The compiled `winutil.ps1` is not source code for editing or review. It is generated by `Compile.ps1` and produced during release automation. All durable changes must be made to the source files that feed the compiler. ## Project Context
WinUtil is a Windows PowerShell utility with a WPF interface. The repository is maintained as modular source, but the distributed artifact is one compiled PowerShell script.
### Stack
- Language: Windows PowerShell / PowerShell.
- UI: WPF via `xaml/inputXML.xaml`.
- Configuration: JSON files under `config/`.
- Tests: Pester tests under `pester/`.
- Lint: PowerShell Script Analyzer with settings in `lint/PSScriptAnalyser.ps1`.
- Docs: Astro + Starlight site under `docs/`, built independently of `Compile.ps1` (its own `package.json`/`node_modules`).
- Release artifact: generated root `winutil.ps1`.
### Repository Layout
- `Compile.ps1`: build script that creates `winutil.ps1`.
- `scripts/start.ps1`: startup/bootstrap segment used at the beginning of the compiled script.
- `scripts/main.ps1`: main entrypoint appended at the end of the compiled script.
- `functions/public/`: public/UI-facing PowerShell functions.
- `functions/private/`: internal helper PowerShell functions.
- `config/`: JSON configuration consumed at compile time and embedded into `$sync.configs`.
- `xaml/inputXML.xaml`: WPF UI markup embedded into the compiled script.
- `tools/autounattend.xml`: unattended setup XML embedded for Windows ISO workflows.
- `pester/`: Pester tests for config and function checks.
- `lint/PSScriptAnalyser.ps1`: PowerShell Script Analyzer settings.
- `docs/`: Astro + Starlight documentation site, with its own `package.json` and build independent of `Compile.ps1`.
- `winutil.ps1`: ignored generated build artifact.
## Goals ## Goals
@@ -21,85 +48,64 @@ The compiled `winutil.ps1` is not source code for editing or review. It is gener
- The GUI is not a separate packaged desktop application in this repository's normal release path. - The GUI is not a separate packaged desktop application in this repository's normal release path.
- Generated files should not be reviewed as source changes. - Generated files should not be reviewed as source changes.
## Repository Layout ## Build Model
- `Compile.ps1`: build script that creates `winutil.ps1`. `Compile.ps1` combines the repository sources into `winutil.ps1` in this order:
- `scripts/start.ps1`: startup/bootstrap segment used at the beginning of the compiled script.
- `scripts/main.ps1`: main entrypoint appended at the end of the compiled script.
- `functions/public/`: public/UI-facing PowerShell functions.
- `functions/private/`: internal helper PowerShell functions.
- `config/`: JSON configuration consumed at compile time and embedded into `$sync.configs`.
- `xaml/inputXML.xaml`: WPF UI markup embedded into the compiled script.
- `tools/autounattend.xml`: unattended setup XML embedded for Windows ISO workflows.
- `pester/`: Pester tests for config and function checks.
- `lint/PSScriptAnalyser.ps1`: PowerShell Script Analyzer settings.
- `docs/`: Hugo documentation site.
- `winutil.ps1`: ignored generated build artifact.
## Compile Specification 1. Read `scripts/start.ps1` and replace `#{replaceme}` with the current `yy.MM.dd` build date.
2. Append every file under `functions/` recursively.
3. Convert each `config/*.json` file into embedded `$sync.configs` objects.
4. Special-case `config/applications.json` so keys receive the `WPFInstall` prefix in compiled config.
5. Embed `xaml/inputXML.xaml` into `$inputXML`.
6. Embed `tools/autounattend.xml` into `$WinUtilAutounattendXml`.
7. Append `scripts/main.ps1`.
8. Write the result to root `winutil.ps1`.
`Compile.ps1` must produce a standalone root `winutil.ps1` by combining all required project files. Because the final script is concatenated, code cannot rely on runtime module imports or source-relative dot-sourcing unless the compiled script will also contain the required code/data.
The compile flow is:
1. Initialize shared state with `$sync = [Hashtable]::Synchronized(@{})` and `$sync.configs = @{}`.
2. Read `scripts/start.ps1`.
3. Replace `#{replaceme}` in startup code with the current `yy.MM.dd` build date.
4. Append raw content from all files under `functions/` recursively.
5. For every file in `config/`, parse JSON and embed it into `$sync.configs.<basename>`.
6. Special-case `config/applications.json` so application keys are emitted with the `WPFInstall` prefix.
7. Embed `xaml/inputXML.xaml` as `$inputXML`.
8. Embed `tools/autounattend.xml` as `$WinUtilAutounattendXml`.
9. Append `scripts/main.ps1`.
10. Write the combined script to `winutil.ps1`.
11. If `-Run` is supplied, execute the generated script.
The generated script must have everything it needs from repository sources embedded or appended by this process.
## Runtime Model ## Runtime Model
- WinUtil runs in PowerShell on Windows and uses WPF for the UI. - WinUtil runs in PowerShell on Windows and uses WPF for the UI.
- Shared mutable state is stored in `$sync`, including configs, UI element references, runspace state, selections, and progress. - Shared mutable state is stored in `$sync`, including configs, UI element references, runspace state, selections, and progress.
- Long-running operations should use runspaces or existing async patterns so the UI remains responsive. - Long-running operations use runspaces or existing async patterns so the UI remains responsive.
- UI updates from background work must be dispatched back to the WPF UI thread. - UI updates from background work are dispatched back to the WPF UI thread.
- Declarative features such as apps, tweaks, presets, DNS providers, and navigation should stay in `config/*.json` unless code is required. - Declarative features such as apps, tweaks, presets, DNS providers, and navigation stay in `config/*.json` unless code is required.
## UI And Event Contract ## UI And Event Contract
- UI layout lives in `xaml/inputXML.xaml`. - UI layout lives in `xaml/inputXML.xaml`.
- Named WPF controls are discovered and stored in `$sync`. - Named WPF controls are discovered and stored in `$sync`.
- Button/action wiring follows existing naming conventions, where an element named like `WPFThingButton` maps to a function named like `Invoke-WPFThingButton`. - Button/action wiring follows a naming convention: an element named like `WPFThingButton` maps to a function named like `Invoke-WPFThingButton`.
- When adding controls, ensure the XAML name, config key, and PowerShell function names line up with the existing event system.
## Configuration Contract ## Configuration Contract
Config files must remain valid JSON and compile cleanly through `ConvertFrom-Json`. - Config files must remain valid JSON and compile cleanly through `ConvertFrom-Json`.
- `config/applications.json` defines installable applications; each entry includes the fields expected by tests and UI code, such as package manager IDs, category, display content, description, and link.
`config/applications.json` defines installable applications. Each application entry should include the fields expected by tests and UI code, such as package manager IDs, category, display content, description, and link. - `config/tweaks.json` defines Windows tweaks; registry and service changes include original values or original states when applicable so undo workflows can restore user systems.
- Preset and navigation files reference valid config keys. Renaming a config key requires updating all presets, UI references, docs, and code paths together.
`config/tweaks.json` defines Windows tweaks. Registry and service changes should include original values or original states when applicable so undo workflows can restore user systems.
Preset and navigation files should reference valid config keys. Avoid renaming config keys unless all presets, UI references, docs, and code paths are updated together.
## Safety Requirements ## Safety Requirements
- Registry, service, package manager, Windows Update, AppX removal, and ISO operations can affect the host system. Changes must be explicit, reversible where practical, and consistent with existing logging and confirmation patterns. - Registry, service, package manager, Windows Update, AppX removal, and ISO operations affect the host system and are treated as high-risk.
- Tweak changes should include undo metadata when the schema supports it. - Tweak changes include undo metadata when the schema supports it, so changes stay reversible.
- Package installation should prefer existing WinGet and Chocolatey helper functions. - ISO workflows never modify the user's original ISO file; they work on copied/mounted content.
- ISO workflows must not modify the user's original ISO file; they should work on copied/mounted content following existing patterns.
## Docs Site (Astro)
- `docs/` is an Astro + Starlight site, independent of `Compile.ps1`'s build (its own `package.json`/`node_modules`, deployed via the `docs.yaml` GitHub Actions workflow to GitHub Pages).
- Pages live under `docs/src/content/docs/` (`.mdx`), organized into `guides/`, `code-reference/`, plus top-level pages like `faq.mdx`, `knownissues.mdx`, `contributing.mdx`, `index.mdx`.
- `docs/src/content/docs/code-reference/tweaks/` and `.../features/` are auto-generated by `tools/devdocs-generator.ps1` from `config/tweaks.json`/`config/feature.json` and the relevant PowerShell function files. Other pages under `code-reference/` (e.g. `architecture.mdx`) are hand-written and untouched by the generator.
- Sidebar entries in `docs/astro.config.mjs` must match actual page slugs under `docs/src/content/docs/`.
- `docs/public/` is tracked source for static assets (favicons, etc.), not generated output. Generated/ignored paths are listed in `docs/.gitignore` (`dist/`, `.astro/`, `node_modules/`, local env files).
## Testing And CI ## Testing And CI
Expected validation for source changes:
- `.\Compile.ps1` verifies the compiler can generate `winutil.ps1`. - `.\Compile.ps1` verifies the compiler can generate `winutil.ps1`.
- `.\Compile.ps1 -Run` compiles and launches the generated utility for manual GUI verification. - `.\Compile.ps1 -Run` compiles and launches the generated utility for manual GUI verification.
- `Install-Module -Name Pester -RequiredVersion 5.8.0 -Scope CurrentUser -Force -SkipPublisherCheck` installs the supported Pester version. - Pester 5.8.0 runs the suite under `pester/*.Tests.ps1`. GitHub Actions (`unittests.yaml`) installs Pester 5.8.0 fresh and runs with `-CI`, which produces `testResults.xml` and exits non-zero on failure.
- `Import-Module Pester -RequiredVersion 5.8.0 -Force; Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI` runs the Pester suite. - GitHub Actions also runs PowerShell Script Analyzer with `lint/PSScriptAnalyser.ps1` on every push.
- GitHub Actions also runs a compile check and PowerShell Script Analyzer with `lint/PSScriptAnalyser.ps1`. - The generated `winutil.ps1` may appear locally after compile. It remains ignored build output (see root `.gitignore`) and must not be committed.
The generated `winutil.ps1` may appear locally after compile. It remains ignored build output and must not be committed.
## Release Artifact ## Release Artifact
GitHub Actions is responsible for producing the release `winutil.ps1` from repository sources. A release should be considered valid only if the generated script came from the compile process, not from direct manual edits to `winutil.ps1`. GitHub Actions is responsible for producing the release `winutil.ps1` from repository sources. A release is considered valid only if the generated script came from the compile process, not from direct manual edits to `winutil.ps1`.
+114 -6
View File
@@ -18,7 +18,7 @@
"foss": true "foss": true
}, },
"adobe": { "adobe": {
"category": "Multimedia Tools", "category": "Document",
"choco": "adobereader", "choco": "adobereader",
"content": "Adobe Acrobat Reader", "content": "Adobe Acrobat Reader",
"description": "Adobe Acrobat Reader is a free PDF viewer with essential features for viewing, printing, and annotating PDF documents.", "description": "Adobe Acrobat Reader is a free PDF viewer with essential features for viewing, printing, and annotating PDF documents.",
@@ -458,6 +458,15 @@
"winget": "flux.flux", "winget": "flux.flux",
"foss": false "foss": false
}, },
"foxpdfreader": {
"category": "Document",
"choco": "foxitreader",
"content": "Foxit PDF Reader",
"description": "Foxit PDF Reader is a free PDF viewer with a familiar ribbon-style interface.",
"link": "https://www.foxit.com/pdf-reader/",
"winget": "Foxit.FoxitReader",
"foss": false
},
"geforcenow": { "geforcenow": {
"category": "Games", "category": "Games",
"choco": "nvidia-geforce-now", "choco": "nvidia-geforce-now",
@@ -701,6 +710,15 @@
"winget": "sylikc.JPEGView", "winget": "sylikc.JPEGView",
"foss": true "foss": true
}, },
"joplin": {
"category": "Document",
"choco": "joplin",
"content": "Joplin",
"description": "Joplin is an open-source note-taking and to-do application with synchronization capabilities.",
"link": "https://joplinapp.org/",
"winget": "Joplin.Joplin",
"foss": true
},
"keepassxc": { "keepassxc": {
"category": "Utilities", "category": "Utilities",
"choco": "keepassxc", "choco": "keepassxc",
@@ -738,7 +756,7 @@
"foss": true "foss": true
}, },
"libreoffice": { "libreoffice": {
"category": "Multimedia Tools", "category": "Document",
"choco": "libreoffice-fresh", "choco": "libreoffice-fresh",
"content": "LibreOffice", "content": "LibreOffice",
"description": "LibreOffice is a powerful and free office suite, compatible with other major office suites.", "description": "LibreOffice is a powerful and free office suite, compatible with other major office suites.",
@@ -882,9 +900,9 @@
"foss": true "foss": true
}, },
"naps2": { "naps2": {
"category": "Multimedia Tools", "category": "Document",
"choco": "naps2", "choco": "naps2",
"content": "NAPS2 (Document Scanner)", "content": "NAPS2 (Scanner)",
"description": "NAPS2 is a document scanning application that simplifies the process of creating electronic documents.", "description": "NAPS2 is a document scanning application that simplifies the process of creating electronic documents.",
"link": "https://www.naps2.com/", "link": "https://www.naps2.com/",
"winget": "Cyanfish.NAPS2", "winget": "Cyanfish.NAPS2",
@@ -980,7 +998,7 @@
"foss": true "foss": true
}, },
"obsidian": { "obsidian": {
"category": "Multimedia Tools", "category": "Document",
"choco": "obsidian", "choco": "obsidian",
"content": "Obsidian", "content": "Obsidian",
"description": "Obsidian is a powerful note-taking and knowledge management application.", "description": "Obsidian is a powerful note-taking and knowledge management application.",
@@ -988,6 +1006,15 @@
"winget": "Obsidian.Obsidian", "winget": "Obsidian.Obsidian",
"foss": false "foss": false
}, },
"okular": {
"category": "Document",
"choco": "okular",
"content": "Okular",
"description": "Okular is a versatile document viewer with advanced features.",
"link": "https://okular.kde.org/",
"winget": "KDE.Okular",
"foss": true
},
"onedrive": { "onedrive": {
"category": "Microsoft Tools", "category": "Microsoft Tools",
"choco": "onedrive", "choco": "onedrive",
@@ -998,7 +1025,7 @@
"foss": false "foss": false
}, },
"onlyoffice": { "onlyoffice": {
"category": "Multimedia Tools", "category": "Document",
"choco": "onlyoffice", "choco": "onlyoffice",
"content": "ONLYOFFICE Desktop", "content": "ONLYOFFICE Desktop",
"description": "ONLYOFFICE Desktop is a comprehensive office suite for document editing and collaboration.", "description": "ONLYOFFICE Desktop is a comprehensive office suite for document editing and collaboration.",
@@ -1087,6 +1114,42 @@
"winget": "Giorgiotani.Peazip", "winget": "Giorgiotani.Peazip",
"foss": true "foss": true
}, },
"pdf-xchange": {
"category": "Document",
"choco": "pdfxchangeeditor",
"content": "PDF-XChange Editor",
"description": "A comprehensive Windows-based software suite and editor for creating, viewing, editing, annotating, and signing PDF files.",
"link": "https://www.pdf-xchange.com/",
"winget": "TrackerSoftware.PDF-XChangeEditor",
"foss": false
},
"pdf24creator": {
"category": "Document",
"choco": "pdf24",
"content": "PDF24 Creator",
"description": "Free and easy-to-use online/desktop PDF tools that make you more productive",
"link": "https://tools.pdf24.org/en/creator",
"winget": "geeksoftwareGmbH.PDF24Creator",
"foss": false
},
"pdfgear": {
"category": "Document",
"choco": "pdfgear",
"content": "PDFgear",
"description": "PDFgear is a piece of full-featured PDF management software for Windows, macOS, and mobile, and it's completely free to use.",
"link": "https://www.pdfgear.com/",
"winget": "PDFgear.PDFgear",
"foss": false
},
"pdfsam": {
"category": "Document",
"choco": "pdfsam",
"content": "PDFsam Basic",
"description": "PDFsam Basic is a free and open-source tool for splitting, merging, and rotating PDF files.",
"link": "https://pdfsam.org/",
"winget": "PDFsam.PDFsam",
"foss": true
},
"playnite": { "playnite": {
"category": "Games", "category": "Games",
"choco": "playnite", "choco": "playnite",
@@ -1339,6 +1402,15 @@
"winget": "WhirlwindFX.SignalRgb", "winget": "WhirlwindFX.SignalRgb",
"foss": false "foss": false
}, },
"simplenote": {
"category": "Document",
"choco": "simplenote",
"content": "Simplenote",
"description": "Simplenote is an easy way to keep notes, lists, ideas and more.",
"link": "https://simplenote.com/",
"winget": "Automattic.Simplenote",
"foss": true
},
"simplewall": { "simplewall": {
"category": "Pro Tools", "category": "Pro Tools",
"choco": "simplewall", "choco": "simplewall",
@@ -1384,6 +1456,15 @@
"winget": "SublimeHQ.SublimeText.4", "winget": "SublimeHQ.SublimeText.4",
"foss": false "foss": false
}, },
"sumatra": {
"category": "Document",
"choco": "sumatrapdf",
"content": "Sumatra PDF",
"description": "Sumatra PDF is a lightweight and fast PDF viewer with minimalistic design.",
"link": "https://www.sumatrapdfreader.org/free-pdf-reader.html",
"winget": "SumatraPDF.SumatraPDF",
"foss": true
},
"sunshine": { "sunshine": {
"category": "Selfhosted Tools", "category": "Selfhosted Tools",
"choco": "sunshine", "choco": "sunshine",
@@ -1429,6 +1510,15 @@
"winget": "TeamSpeakSystems.TeamSpeakClient", "winget": "TeamSpeakSystems.TeamSpeakClient",
"foss": false "foss": false
}, },
"teamspeak6": {
"category": "Communications",
"choco": "na",
"content": "TeamSpeak 6",
"description": "TEAMSPEAK. YOUR TEAM. YOUR RULES. Use crystal clear sound to communicate with your teammates cross-platform with military-grade security, lag-free performance & unparalleled reliability and uptime.",
"link": "https://www.teamspeak.com/",
"winget": "TeamSpeakSystems.TeamSpeakClient.Beta.6",
"foss": false
},
"telegram": { "telegram": {
"category": "Communications", "category": "Communications",
"choco": "telegram", "choco": "telegram",
@@ -1726,6 +1816,15 @@
"winget": "MHNexus.HxD", "winget": "MHNexus.HxD",
"foss": false "foss": false
}, },
"xournal": {
"category": "Document",
"choco": "xournalplusplus",
"content": "Xournal++",
"description": "Xournal++ is an open-source handwriting notetaking software with PDF annotation capabilities.",
"link": "https://xournalpp.github.io/",
"winget": "Xournal++.Xournal++",
"foss": true
},
"yarn": { "yarn": {
"category": "Development", "category": "Development",
"choco": "yarn", "choco": "yarn",
@@ -1807,6 +1906,15 @@
"winget": "ZedIndustries.Zed", "winget": "ZedIndustries.Zed",
"foss": true "foss": true
}, },
"zotero": {
"category": "Document",
"choco": "zotero",
"content": "Zotero",
"description": "Zotero is a free, easy-to-use tool to help you collect, organize, cite, and share your research materials.",
"link": "https://www.zotero.org/",
"winget": "DigitalScholar.Zotero",
"foss": true
},
"deskflow": { "deskflow": {
"category": "Utilities", "category": "Utilities",
"choco": "deskflow", "choco": "deskflow",
+1 -2
View File
@@ -1454,8 +1454,7 @@
"Value": "0", "Value": "0",
"Type": "DWord", "Type": "DWord",
"OriginalValue": "1", "OriginalValue": "1",
"DefaultState": "false", "DefaultState": "false"
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/scrollbars"
} }
], ],
"link": "https://winutil.christitus.com/code-reference/tweaks/customize-preferences/scrollbars" "link": "https://winutil.christitus.com/code-reference/tweaks/customize-preferences/scrollbars"
+2
View File
@@ -16,6 +16,8 @@ pnpm-debug.log*
# environment variables # environment variables
.env .env
.env.production .env.production
.env.local
.env.*.local
# macOS-specific files # macOS-specific files
.DS_Store .DS_Store
+8 -2
View File
@@ -1,6 +1,7 @@
// @ts-check // @ts-check
import { defineConfig } from 'astro/config'; import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight'; import starlight from '@astrojs/starlight';
import { siteLinks } from './src/site-links.ts';
// https://astro.build/config // https://astro.build/config
export default defineConfig({ export default defineConfig({
@@ -18,16 +19,19 @@ export default defineConfig({
{ icon: 'github', label: 'GitHub', href: 'https://github.com/ChrisTitusTech/winutil' }, { icon: 'github', label: 'GitHub', href: 'https://github.com/ChrisTitusTech/winutil' },
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/RUbZUZyByQ' }, { icon: 'discord', label: 'Discord', href: 'https://discord.gg/RUbZUZyByQ' },
], ],
// Global theme overrides (colors, fonts, landing-page section styles).
customCss: ['./src/styles/theme.css'], customCss: ['./src/styles/theme.css'],
// Custom component overrides, all under src/components/.
components: { components: {
ThemeProvider: './src/components/ThemeProvider.astro', ThemeProvider: './src/components/ThemeProvider.astro',
Hero: './src/components/Hero.astro',
Header: './src/components/Header.astro', Header: './src/components/Header.astro',
Hero: './src/components/Hero.astro',
Footer: './src/components/Footer.astro', Footer: './src/components/Footer.astro',
}, },
editLink: { editLink: {
baseUrl: 'https://github.com/ChrisTitusTech/winutil/edit/main/docs/', baseUrl: 'https://github.com/ChrisTitusTech/winutil/edit/main/docs/',
}, },
// Sidebar groups, top to bottom: User Guide, Code Reference, Help.
sidebar: [ sidebar: [
{ {
label: 'User Guide', label: 'User Guide',
@@ -54,10 +58,12 @@ export default defineConfig({
label: 'Help', label: 'Help',
items: [ items: [
{ label: 'FAQ', slug: 'faq' }, { label: 'FAQ', slug: 'faq' },
{ label: 'Known Issues', slug: 'known-issues' }, { label: 'Known Issues', slug: 'knownissues' },
{ label: 'Contributing', slug: 'contributing' }, { label: 'Contributing', slug: 'contributing' },
{ label: siteLinks.forums.label, link: siteLinks.forums.href, attrs: { target: '_blank', rel: 'noreferrer' } },
], ],
}, },
{ label: siteLinks.store.label, link: siteLinks.store.href, attrs: { target: '_blank', rel: 'noreferrer' } },
], ],
}), }),
], ],
Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 139 KiB

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

+4
View File
@@ -12,11 +12,13 @@ const { icon, title } = Astro.props;
--- ---
<div class="wu-corner-card"> <div class="wu-corner-card">
{/* Corner brackets decoration. */}
<span class="wu-corner-marks" aria-hidden="true"> <span class="wu-corner-marks" aria-hidden="true">
<span class="mark top-left" /><span class="mark top-right" /><span class="mark bottom-left" /><span <span class="mark top-left" /><span class="mark top-right" /><span class="mark bottom-left" /><span
class="mark bottom-right" class="mark bottom-right"
/> />
</span> </span>
{/* Icon badge + heading + description. */}
<div class="wu-corner-card-icon"> <div class="wu-corner-card-icon">
<Icon name={icon} size="1.25rem" /> <Icon name={icon} size="1.25rem" />
</div> </div>
@@ -36,6 +38,7 @@ const { icon, title } = Astro.props;
background-color: var(--sl-color-bg); background-color: var(--sl-color-bg);
} }
/* Corner brackets decoration (four small L-shaped marks). */
.wu-corner-marks { .wu-corner-marks {
position: absolute; position: absolute;
inset: 0; inset: 0;
@@ -93,6 +96,7 @@ const { icon, title } = Astro.props;
right: 0; right: 0;
} }
/* Icon badge + heading + description. */
.wu-corner-card-icon { .wu-corner-card-icon {
display: flex; display: flex;
align-items: center; align-items: center;
+7 -4
View File
@@ -9,12 +9,14 @@ const year = new Date().getFullYear();
--- ---
<footer class="sl-flex"> <footer class="sl-flex">
{/* Edit link + last-updated timestamp, and prev/next pagination. */}
<div class="meta sl-flex"> <div class="meta sl-flex">
<EditLink /> <EditLink />
<LastUpdated /> <LastUpdated />
</div> </div>
<Pagination /> <Pagination />
{/* "Built with Starlight" credit (only shown if Starlight's `credits` config is enabled). */}
{ {
config.credits && ( config.credits && (
<a class="kudos sl-flex" href="https://starlight.astro.build"> <a class="kudos sl-flex" href="https://starlight.astro.build">
@@ -23,11 +25,13 @@ const year = new Date().getFullYear();
) )
} }
{/* Copyright line. */}
<div class="site-footer-copyright">© {year} <a href="https://christitus.com">Chris Titus Tech</a>. All rights reserved.</div> <div class="site-footer-copyright">© {year} <a href="https://christitus.com">Chris Titus Tech</a>. All rights reserved.</div>
</footer> </footer>
<style> <style>
@layer starlight.core { @layer starlight.core {
/* Footer layout: stacked meta row + pagination. */
footer { footer {
flex-direction: column; flex-direction: column;
gap: 1.5rem; gap: 1.5rem;
@@ -44,6 +48,7 @@ const year = new Date().getFullYear();
margin-inline-start: auto; margin-inline-start: auto;
} }
/* "Built with Starlight" credit link. */
.kudos { .kudos {
align-items: center; align-items: center;
gap: 0.5em; gap: 0.5em;
@@ -63,16 +68,14 @@ const year = new Date().getFullYear();
} }
} }
/* Collapse the meta/pagination rows entirely when they have nothing in them /* Collapse the meta/pagination rows entirely when they have nothing in them (e.g. editUrl: false and no prev/next), instead of leaving an empty gap. */
(e.g. editUrl: false and no prev/next), instead of leaving an empty gap. */
footer .meta:empty, footer .meta:empty,
footer :global(.pagination-links):empty { footer :global(.pagination-links):empty {
display: none; display: none;
margin: 0; margin: 0;
} }
/* Site-wide copyright line, matching the previous Hugo docs site's footer. /* Site-wide copyright line, matching the previous Hugo docs site's footer. The divider above it comes from Starlight's own .content-panel border. */
The divider above it comes from Starlight's own .content-panel border. */
.site-footer-copyright { .site-footer-copyright {
font-size: var(--sl-text-xs); font-size: var(--sl-text-xs);
color: var(--sl-color-gray-3); color: var(--sl-color-gray-3);
+172 -19
View File
@@ -6,40 +6,79 @@ import Search from 'virtual:starlight/components/Search';
import SiteTitle from 'virtual:starlight/components/SiteTitle'; import SiteTitle from 'virtual:starlight/components/SiteTitle';
import SocialIcons from 'virtual:starlight/components/SocialIcons'; import SocialIcons from 'virtual:starlight/components/SocialIcons';
import ThemeSelect from 'virtual:starlight/components/ThemeSelect'; import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
import { Icon } from '@astrojs/starlight/components';
import { siteLinks } from '../site-links';
/** // Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
* Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
*/
const shouldRenderSearch = const shouldRenderSearch =
config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro'; config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
// Pages with a sidebar already have Starlight's own mobile menu toggle; only splash pages need this one.
const { hasSidebar } = Astro.locals.starlightRoute;
--- ---
<div class="header"> <div class="header">
{/* Site title. */}
<div class="title-wrapper sl-flex"> <div class="title-wrapper sl-flex">
<SiteTitle /> <SiteTitle />
</div> </div>
<div class="mobile-actions sl-flex">
{/* Search box. */}
<div class="sl-flex print:hidden"> <div class="sl-flex print:hidden">
{shouldRenderSearch && <Search />} {shouldRenderSearch && <Search />}
</div> </div>
{
!hasSidebar && (
<div class="site-nav-toggle sl-flex md:sl-hidden print:hidden">
<button type="button" aria-expanded="false" aria-controls="site-nav-panel" aria-label="Site navigation">
<Icon name="bars" class="open-menu" />
<Icon name="close" class="close-menu" />
</button>
<div id="site-nav-panel" class="site-nav-panel">
<div class="site-nav-panel-group">
<p class="site-nav-panel-heading">Documentation</p>
<a href="/guides/">User Guides</a>
<a href="/contributing/">Contribution Guides</a>
<a href="/code-reference/architecture/">Code Reference</a>
</div>
<div class="site-nav-panel-group">
<p class="site-nav-panel-heading">Help</p>
<a href="/faq/">FAQ</a>
<a href="/knownissues/">Known Issues</a>
<a href={siteLinks.forums.href} target="_blank" rel="noreferrer">{siteLinks.forums.label}</a>
</div>
<a class="site-nav-panel-link" href={siteLinks.store.href} target="_blank" rel="noreferrer">{siteLinks.store.label}</a>
</div>
</div>
)
}
</div>
{/* Right-side group: nav links, social icons, theme/language pickers. */}
<div class="sl-hidden md:sl-flex print:hidden right-group"> <div class="sl-hidden md:sl-flex print:hidden right-group">
<nav class="site-nav" aria-label="Top"> <nav class="site-nav" aria-label="Top">
<a class="site-nav-link" href="/guides/">User Guides</a> {/* "Documentation" dropdown. */}
<div class="site-nav-dropdown"> <div class="site-nav-dropdown">
<button type="button" class="site-nav-link" aria-haspopup="true">Documentation</button> <details name="site-nav-dropdown">
<summary class="site-nav-link">Documentation</summary>
</details>
<div class="site-nav-menu"> <div class="site-nav-menu">
<a href="/guides/">User Guides</a>
<a href="/contributing/">Contribution Guides</a> <a href="/contributing/">Contribution Guides</a>
<a href="/code-reference/architecture/">Developer Docs</a> <a href="/code-reference/architecture/">Code Reference</a>
</div> </div>
</div> </div>
{/* "Help" dropdown. */}
<div class="site-nav-dropdown"> <div class="site-nav-dropdown">
<button type="button" class="site-nav-link" aria-haspopup="true">Help</button> <details name="site-nav-dropdown">
<summary class="site-nav-link">Help</summary>
</details>
<div class="site-nav-menu"> <div class="site-nav-menu">
<a href="/faq/">FAQ</a> <a href="/faq/">FAQ</a>
<a href="/known-issues/">Known Issues</a> <a href="/knownissues/">Known Issues</a>
<a href="https://forum.christitus.com/" target="_blank" rel="noreferrer">Forums</a> <a href={siteLinks.forums.href} target="_blank" rel="noreferrer">{siteLinks.forums.label}</a>
</div> </div>
</div> </div>
<a class="site-nav-link" href="https://christitus.com/downloads/" target="_blank" rel="noreferrer">Store</a> <a class="site-nav-link" href={siteLinks.store.href} target="_blank" rel="noreferrer">{siteLinks.store.label}</a>
</nav> </nav>
<div class="sl-flex social-icons"> <div class="sl-flex social-icons">
<SocialIcons /> <SocialIcons />
@@ -49,8 +88,28 @@ const shouldRenderSearch =
</div> </div>
</div> </div>
<script>
const toggle = document.querySelector<HTMLElement>('.site-nav-toggle');
const btn = toggle?.querySelector('button');
if (toggle && btn) {
const setExpanded = (expanded: boolean) => btn.setAttribute('aria-expanded', String(expanded));
btn.addEventListener('click', () => setExpanded(btn.getAttribute('aria-expanded') !== 'true'));
toggle.addEventListener('keyup', (e) => {
if (e.code === 'Escape') {
setExpanded(false);
btn.focus();
}
});
// Collapse the panel if the viewport grows past the mobile breakpoint.
matchMedia('(min-width: 50em)').addEventListener('change', () => setExpanded(false));
}
</script>
<style> <style>
@layer starlight.core { @layer starlight.core {
/* Header shell: title, search, right-side nav group. */
.header { .header {
display: flex; display: flex;
gap: var(--sl-nav-gap); gap: var(--sl-nav-gap);
@@ -60,14 +119,19 @@ const shouldRenderSearch =
} }
.title-wrapper { .title-wrapper {
/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */ /* Clips long titles instead of overflowing onto the search/menu buttons; padding/negative margin avoids clipping the focus ring. */
overflow: clip; overflow: clip;
/* Avoid clipping focus ring around title wrapper. */
padding: 0.25rem; padding: 0.25rem;
margin: -0.25rem; margin: -0.25rem;
min-width: 0; min-width: 0;
} }
.mobile-actions {
align-items: center;
gap: 0.75rem;
}
/* Right-side group: nav + social icons, divided by a hairline. */
.right-group, .right-group,
.social-icons { .social-icons {
gap: 1rem; gap: 1rem;
@@ -86,6 +150,7 @@ const shouldRenderSearch =
:global(:root:not([data-has-toc])) { :global(:root:not([data-has-toc])) {
--__toc-width: 0rem; --__toc-width: 0rem;
} }
/* Columns: site title */
.header { .header {
--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x)); --__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
--__main-column-fr: calc( --__main-column-fr: calc(
@@ -97,21 +162,18 @@ const shouldRenderSearch =
); );
display: grid; display: grid;
grid-template-columns: grid-template-columns:
/* 1 (site title): runs up until the main content columns left edge or the width of the title, whichever is the largest */
minmax( minmax(
calc(var(--__sidebar-width) + max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))), calc(var(--__sidebar-width) + max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))),
auto auto
) )
/* 2 (search box): all free space that is available. */
1fr 1fr
/* 3 (right items): use the space that these need. */
auto; auto;
align-content: center; align-content: center;
} }
} }
} }
/* Top nav links + dropdowns, matching the previous Hugo docs site's navbar. */ /* Top nav links + dropdowns. */
.site-nav { .site-nav {
display: flex; display: flex;
align-items: center; align-items: center;
@@ -120,6 +182,7 @@ const shouldRenderSearch =
border-inline-end: 1px solid var(--sl-color-hairline-light); border-inline-end: 1px solid var(--sl-color-hairline-light);
} }
/* Top nav trigger: shared style for plain links and dropdown triggers. */
.site-nav-link { .site-nav-link {
font-size: var(--sl-text-sm); font-size: var(--sl-text-sm);
font-weight: 500; font-weight: 500;
@@ -136,13 +199,25 @@ const shouldRenderSearch =
color: var(--sl-color-white); color: var(--sl-color-white);
} }
/* Extends the hoverable box down to the menu, closing the dead zone between trigger and menu. */
.site-nav-dropdown { .site-nav-dropdown {
position: relative; position: relative;
/* Extends the dropdown's own hoverable box down to meet the menu, so the
cursor never crosses a dead zone between the trigger and the menu. */
padding-bottom: 0.75rem; padding-bottom: 0.75rem;
margin-bottom: -0.75rem; margin-bottom: -0.75rem;
} }
/* No box of its own; only the <summary> lays out. Its `open` state (no JS) is read by .site-nav-menu below. */
.site-nav-dropdown > details {
display: contents;
}
.site-nav-dropdown > details > summary {
display: inline-flex;
align-items: center;
list-style: none;
}
.site-nav-dropdown > details > summary::-webkit-details-marker {
display: none;
}
/* Dropdown menu panel: shown on hover (mouse) or when the sibling <details> is toggled open (touch/keyboard). */
.site-nav-menu { .site-nav-menu {
display: none; display: none;
position: absolute; position: absolute;
@@ -160,7 +235,7 @@ const shouldRenderSearch =
z-index: 10; z-index: 10;
} }
.site-nav-dropdown:hover .site-nav-menu, .site-nav-dropdown:hover .site-nav-menu,
.site-nav-dropdown:focus-within .site-nav-menu { .site-nav-dropdown:has(details[open]) .site-nav-menu {
display: flex; display: flex;
} }
.site-nav-menu a { .site-nav-menu a {
@@ -175,4 +250,82 @@ const shouldRenderSearch =
color: var(--sl-color-white); color: var(--sl-color-white);
background: var(--sl-color-gray-6); background: var(--sl-color-gray-6);
} }
/* Mobile equivalent of the site-nav, shown via a toggle button since the desktop nav is hidden below `md`. */
.site-nav-toggle button {
display: flex;
align-items: center;
justify-content: center;
width: 2.25rem;
height: 2.25rem;
border: 0;
border-radius: var(--wu-radius-sm, 0.5rem);
padding: 0;
background: none;
color: var(--sl-color-gray-2);
cursor: pointer;
}
.site-nav-toggle button:hover {
color: var(--sl-color-white);
}
.site-nav-toggle button svg {
width: 1.25rem;
height: 1.25rem;
}
.site-nav-toggle button[aria-expanded='true'] .open-menu,
.site-nav-toggle button:not([aria-expanded='true']) .close-menu {
display: none;
}
.site-nav-panel {
display: none;
position: fixed;
inset-inline: 0;
top: var(--sl-nav-height);
z-index: var(--sl-z-index-menu);
flex-direction: column;
gap: 0.25rem;
max-height: calc(100vh - var(--sl-nav-height));
overflow-y: auto;
padding: 1rem var(--sl-nav-pad-x) 1.5rem;
background: var(--sl-color-bg-nav);
border-bottom: 1px solid var(--sl-color-hairline-shade);
}
.site-nav-toggle button[aria-expanded='true'] ~ .site-nav-panel {
display: flex;
}
.site-nav-panel-link {
padding: 0.5rem 0.25rem;
font-size: var(--sl-text-sm);
font-weight: 500;
color: var(--sl-color-gray-2);
text-decoration: none;
}
.site-nav-panel-link:hover {
color: var(--sl-color-white);
}
.site-nav-panel-group {
display: flex;
flex-direction: column;
border-top: 1px solid var(--sl-color-hairline-light);
padding-top: 0.5rem;
}
.site-nav-panel-heading {
margin: 0 0 0.25rem;
padding: 0 0.25rem;
font-size: var(--sl-text-xs);
font-weight: 600;
text-transform: uppercase;
letter-spacing: 0.02em;
color: var(--sl-color-gray-3);
}
.site-nav-panel-group a {
padding: 0.5rem 0.25rem;
font-size: var(--sl-text-sm);
color: var(--sl-color-gray-2);
text-decoration: none;
}
.site-nav-panel-group a:hover {
color: var(--sl-color-white);
}
</style> </style>
+7
View File
@@ -6,6 +6,7 @@ import { Icon } from '@astrojs/starlight/components';
// Matches Starlight's internal PAGE_TITLE_ID (used by the skip-to-content link). // Matches Starlight's internal PAGE_TITLE_ID (used by the skip-to-content link).
const PAGE_TITLE_ID = '_top'; const PAGE_TITLE_ID = '_top';
// Resolve hero content: Starlight's built-in hero fields plus our custom schema extensions.
const { data } = Astro.locals.starlightRoute.entry; const { data } = Astro.locals.starlightRoute.entry;
const { title = data.title, tagline, image, actions = [] } = data.hero || {}; const { title = data.title, tagline, image, actions = [] } = data.hero || {};
const { heroEyebrow, heroCaption, heroBadges = [] } = data; const { heroEyebrow, heroCaption, heroBadges = [] } = data;
@@ -15,9 +16,11 @@ if (image && 'file' in image) heroImage = image.file;
--- ---
<section class="wu-hero"> <section class="wu-hero">
{/* Full-bleed grid/glow background layer. */}
<div class="wu-hero-grid" aria-hidden="true"></div> <div class="wu-hero-grid" aria-hidden="true"></div>
<div class="wu-hero-glow" aria-hidden="true"></div> <div class="wu-hero-glow" aria-hidden="true"></div>
<div class="wu-hero-inner"> <div class="wu-hero-inner">
{/* Copy column: eyebrow, heading, tagline, actions, caption. */}
<div class="wu-hero-copy"> <div class="wu-hero-copy">
{heroEyebrow && <p class="wu-eyebrow">{heroEyebrow}</p>} {heroEyebrow && <p class="wu-eyebrow">{heroEyebrow}</p>}
<h1 id={PAGE_TITLE_ID} data-page-title set:html={title} /> <h1 id={PAGE_TITLE_ID} data-page-title set:html={title} />
@@ -42,6 +45,7 @@ if (image && 'file' in image) heroImage = image.file;
} }
{heroCaption && <p class="wu-hero-caption">{heroCaption}</p>} {heroCaption && <p class="wu-hero-caption">{heroCaption}</p>}
</div> </div>
{/* Screenshot framed as a fake browser/app window. */}
{ {
heroImage && ( heroImage && (
<div class="wu-hero-media"> <div class="wu-hero-media">
@@ -66,6 +70,7 @@ if (image && 'file' in image) heroImage = image.file;
) )
} }
</div> </div>
{/* Badge row (shields.io / dcbadge images) below the two-column layout. */}
{ {
heroBadges.length > 0 && ( heroBadges.length > 0 && (
<div class="wu-hero-bottom"> <div class="wu-hero-bottom">
@@ -138,6 +143,7 @@ if (image && 'file' in image) heroImage = image.file;
padding-block: 3rem 2rem; padding-block: 3rem 2rem;
} }
/* Hero copy: eyebrow, heading, tagline, actions, caption. */
.wu-hero-copy { .wu-hero-copy {
text-align: center; text-align: center;
} }
@@ -198,6 +204,7 @@ if (image && 'file' in image) heroImage = image.file;
box-shadow: 0 25px 50px -12px hsl(0 0% 0% / 0.5); box-shadow: 0 25px 50px -12px hsl(0 0% 0% / 0.5);
} }
/* Window chrome: title bar + traffic-light buttons. */
.wu-window-bar { .wu-window-bar {
display: flex; display: flex;
align-items: center; align-items: center;
+2
View File
@@ -5,10 +5,12 @@ import { Icon } from '@astrojs/starlight/components';
<script is:inline> <script is:inline>
window.StarlightThemeProvider = (() => { window.StarlightThemeProvider = (() => {
// Apply the resolved theme to <html> immediately, before paint, to avoid a flash of the wrong theme.
const storedTheme = const storedTheme =
typeof localStorage !== 'undefined' && localStorage.getItem('starlight-theme'); typeof localStorage !== 'undefined' && localStorage.getItem('starlight-theme');
const theme = storedTheme || 'dark'; const theme = storedTheme || 'dark';
document.documentElement.dataset.theme = theme === 'light' ? 'light' : 'dark'; document.documentElement.dataset.theme = theme === 'light' ? 'light' : 'dark';
// Re-syncs each theme-select picker's icon + value after the visitor changes theme.
return { return {
updatePickers(theme = storedTheme || 'auto') { updatePickers(theme = storedTheme || 'auto') {
document.querySelectorAll('starlight-theme-select').forEach((picker) => { document.querySelectorAll('starlight-theme-select').forEach((picker) => {
+39
View File
@@ -0,0 +1,39 @@
---
// Responsive 16:9 YouTube embed using the privacy-enhanced (nocookie) domain.
interface Props {
id: string;
title: string;
}
const { id, title } = Astro.props;
---
<div class="wu-video-embed not-content">
<iframe
src={`https://www.youtube-nocookie.com/embed/${id}`}
title={title}
loading="lazy"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
</div>
<style>
/* `not-content` on the wrapper opts it out of Starlight's markdown reset, which otherwise forces `iframe { height: auto }`. */
.wu-video-embed {
position: relative;
width: 100%;
aspect-ratio: 16 / 9;
margin: 1.5rem 0;
border: 1px solid var(--sl-color-hairline-light);
background-color: var(--sl-color-black);
}
.wu-video-embed iframe {
position: absolute;
inset: 0;
width: 100%;
height: 100%;
border: 0;
}
</style>
@@ -1,10 +1,11 @@
--- ---
title: "Legacy F8 Boot Recovery - Disable" title: "Legacy F8 Boot Recovery - Disable"
description: "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes." description: "Disables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Legacy F8 Boot Recovery - Enable" title: "Legacy F8 Boot Recovery - Enable"
description: "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes." description: "Enables Advanced Boot Options screen that lets you start Windows in advanced troubleshooting modes."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Registry Backup (Daily Task 12:30am) - Enable" title: "Registry Backup (Daily Task 12:30am) - Enable"
description: "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803." description: "Enables daily registry backup, previously disabled by Microsoft in Windows 10 1803."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Windows Sandbox - Enable" title: "Windows Sandbox - Enable"
description: "Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation." description: "Windows Sandbox is a lightweight virtual machine that provides a temporary desktop environment to safely run applications and programs in isolation."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: ".NET Framework (Versions 2, 3, 4) - Enable" title: ".NET Framework (Versions 2, 3, 4) - Enable"
description: ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications." description: ".NET and .NET Framework is a developer platform made up of tools, programming languages, and libraries for building many different types of applications."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Hyper-V - Enable" title: "Hyper-V - Enable"
description: "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines." description: "Hyper-V is a hardware virtualization product developed by Microsoft that allows users to create and manage virtual machines."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Legacy Media Components (WMP, DirectPlay) - Enable" title: "Legacy Media Components (WMP, DirectPlay) - Enable"
description: "Enables legacy programs from previous versions of Windows." description: "Enables legacy programs from previous versions of Windows."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Network File System (NFS) - Enable" title: "Network File System (NFS) - Enable"
description: "Network File System (NFS) is a mechanism for storing files on a network." description: "Network File System (NFS) is a mechanism for storing files on a network."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Windows Subsystem for Linux (WSL) - Enable" title: "Windows Subsystem for Linux (WSL) - Enable"
description: "Windows Subsystem for Linux is an optional feature of Windows that allows Linux programs to run natively on Windows without the need for a separate virtual machine or dual booting." description: "Windows Subsystem for Linux is an optional feature of Windows that allows Linux programs to run natively on Windows without the need for a separate virtual machine or dual booting."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "AutoLogon - Run" title: "AutoLogon - Run"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFPanelAutologin.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFPanelAutologin.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFPanelAutologin.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFPanelAutologin.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFPanelAutologin.ps1" ```powershell title="functions/public/Invoke-WPFPanelAutologin.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "System Corruption Scan - Run" title: "System Corruption Scan - Run"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFSystemRepair.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFSystemRepair.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFSystemRepair.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFSystemRepair.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFSystemRepair.ps1" ```powershell title="functions/public/Invoke-WPFSystemRepair.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "NTP Server - Enable" title: "NTP Server - Enable"
description: "Replaces the default Windows NTP server (time.windows.com) with pool.ntp.org for improved time synchronization accuracy and reliability." description: "Replaces the default Windows NTP server (time.windows.com) with pool.ntp.org for improved time synchronization accuracy and reliability."
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFFixesNTPPool.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNTPPool.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFFixesNTPPool.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNTPPool.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFFixesNTPPool.ps1" ```powershell title="functions/public/Invoke-WPFFixesNTPPool.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "Network - Reset" title: "Network - Reset"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFFixesNetwork.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNetwork.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFFixesNetwork.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesNetwork.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFFixesNetwork.ps1" ```powershell title="functions/public/Invoke-WPFFixesNetwork.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "Windows Update - Reset" title: "Windows Update - Reset"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFFixesUpdate.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesUpdate.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFFixesUpdate.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesUpdate.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFFixesUpdate.ps1" ```powershell title="functions/public/Invoke-WPFFixesUpdate.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "WinGet - Reinstall" title: "WinGet - Reinstall"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFFixesWinget.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesWinget.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFFixesWinget.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFFixesWinget.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFFixesWinget.ps1" ```powershell title="functions/public/Invoke-WPFFixesWinget.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "Computer Management" title: "Computer Management"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Control Panel" title: "Control Panel"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Windows Defender Firewall" title: "Windows Defender Firewall"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Mouse Properties" title: "Mouse Properties"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Network Connections" title: "Network Connections"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Power Panel" title: "Power Panel"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Printer Panel" title: "Printer Panel"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Programs and Features" title: "Programs and Features"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Region" title: "Region"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Windows Restore" title: "Windows Restore"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Security and Maintenance" title: "Security and Maintenance"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Sound Settings" title: "Sound Settings"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "System Properties" title: "System Properties"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "Time and Date" title: "Time and Date"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/feature.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/feature.json). Do not edit this page directly.
::: :::
```json title="config/feature.json" ```json title="config/feature.json"
@@ -1,10 +1,11 @@
--- ---
title: "CTT PowerShell Profile - Install" title: "CTT PowerShell Profile - Install"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/private/Invoke-WinUtilInstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilInstallPSProfile.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/private/Invoke-WinUtilInstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilInstallPSProfile.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/private/Invoke-WinUtilInstallPSProfile.ps1" ```powershell title="functions/private/Invoke-WinUtilInstallPSProfile.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "CTT PowerShell Profile - Remove" title: "CTT PowerShell Profile - Remove"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/private/Invoke-WinUtilUninstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilUninstallPSProfile.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/private/Invoke-WinUtilUninstallPSProfile.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/private/Invoke-WinUtilUninstallPSProfile.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/private/Invoke-WinUtilUninstallPSProfile.ps1" ```powershell title="functions/private/Invoke-WinUtilUninstallPSProfile.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "OpenSSH Server - Enable" title: "OpenSSH Server - Enable"
description: "" description: ""
editUrl: false
--- ---
:::note :::note
This page is generated from [`functions/public/Invoke-WPFSSHServer.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFSSHServer.ps1). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`functions/public/Invoke-WPFSSHServer.ps1`](https://github.com/ChrisTitusTech/winutil/blob/main/functions/public/Invoke-WPFSSHServer.ps1). Do not edit this page directly.
::: :::
```powershell title="functions/public/Invoke-WPFSSHServer.ps1" ```powershell title="functions/public/Invoke-WPFSSHServer.ps1"
@@ -1,10 +1,11 @@
--- ---
title: "System Tray Battery Percentage" title: "System Tray Battery Percentage"
description: "Shows numeric battery percentage next to the battery icon in the system tray." description: "Shows numeric battery percentage next to the battery icon in the system tray."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Start Menu Bing Search" title: "Start Menu Bing Search"
description: "Toggles Bing web search results in Windows Search." description: "Toggles Bing web search results in Windows Search."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Dark Theme for Windows" title: "Dark Theme for Windows"
description: "Dark Mode for the system and applications." description: "Dark Mode for the system and applications."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "BSoD Verbose Mode" title: "BSoD Verbose Mode"
description: "Gives more information when you blue screen." description: "Gives more information when you blue screen."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Lock Screen - Disable" title: "Lock Screen - Disable"
description: "Skips the lock screen entirely and goes directly to the sign-in screen on boot and wake." description: "Skips the lock screen entirely and goes directly to the sign-in screen on boot and wake."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Game Mode" title: "Game Mode"
description: "Toggles Windows prioritizes gaming performance by allocating system resources to games." description: "Toggles Windows prioritizes gaming performance by allocating system resources to games."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "File Explorer Hidden Files" title: "File Explorer Hidden Files"
description: "Reveals hidden files in Explorer." description: "Reveals hidden files in Explorer."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Settings Home Page" title: "Settings Home Page"
description: "Toggles the Home Page in the Windows Settings app." description: "Toggles the Home Page in the Windows Settings app."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Logon Screen Acrylic Blur" title: "Logon Screen Acrylic Blur"
description: "Toggles the acrylic blur effect on login screen background." description: "Toggles the acrylic blur effect on login screen background."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Enable Long Paths" title: "Enable Long Paths"
description: "Toggles support for file paths longer than 260 characters in Explorer." description: "Toggles support for file paths longer than 260 characters in Explorer."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Mouse Acceleration" title: "Mouse Acceleration"
description: "Makes it so Cursor movement is affected by the speed of your physical mouse movements." description: "Makes it so Cursor movement is affected by the speed of your physical mouse movements."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Multiplane Overlay" title: "Multiplane Overlay"
description: "Multiplane Overlay compose multiple image layers, which can sometimes cause issues with graphics cards." description: "Multiplane Overlay compose multiple image layers, which can sometimes cause issues with graphics cards."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Microsoft Outlook New Version" title: "Microsoft Outlook New Version"
description: "This will ensures the classic Outlook application is used." description: "This will ensures the classic Outlook application is used."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Num Lock on Startup" title: "Num Lock on Startup"
description: "Toggle the Num Lock key state when your computer starts." description: "Toggle the Num Lock key state when your computer starts."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "S3 Sleep" title: "S3 Sleep"
description: "Toggles between Modern Standby and S3 Sleep, which cuts off power to the CPU while continuing to refresh the memory." description: "Toggles between Modern Standby and S3 Sleep, which cuts off power to the CPU while continuing to refresh the memory."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Scrollbars Always Visible" title: "Scrollbars Always Visible"
description: "If enabled, scrollbars will always be visible. If disabled, Windows will automatically hide scrollbars when not in use." description: "If enabled, scrollbars will always be visible. If disabled, Windows will automatically hide scrollbars when not in use."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -21,8 +22,7 @@ This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitus
"Value": "0", "Value": "0",
"Type": "DWord", "Type": "DWord",
"OriginalValue": "1", "OriginalValue": "1",
"DefaultState": "false", "DefaultState": "false"
"link": "https://winutil.christitus.com/dev/tweaks/customize-preferences/scrollbars"
} }
], ],
} }
@@ -1,10 +1,11 @@
--- ---
title: "File Explorer File Extensions" title: "File Explorer File Extensions"
description: "Shows .file extensions in Explorer (.exe, .png, etc.)" description: "Shows .file extensions in Explorer (.exe, .png, etc.)"
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "S0 Sleep Network Connectivity" title: "S0 Sleep Network Connectivity"
description: "Toggles network connectivity during S0 Sleep which is low power idle in modern laptops." description: "Toggles network connectivity during S0 Sleep which is low power idle in modern laptops."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Start Menu Recommendations" title: "Start Menu Recommendations"
description: "Toggles the recommendations section in the Start Menu. WARNING: This will also disable Windows Spotlight on your Lock Screen as a side effect." description: "Toggles the recommendations section in the Start Menu. WARNING: This will also disable Windows Spotlight on your Lock Screen as a side effect."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Sticky Keys" title: "Sticky Keys"
description: "Toggles the Sticky Keys, which activate when clicking shift rapidly." description: "Toggles the Sticky Keys, which activate when clicking shift rapidly."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Taskbar Task View Icon" title: "Taskbar Task View Icon"
description: "Toggles the Task View Button in the Taskbar." description: "Toggles the Task View Button in the Taskbar."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Taskbar Centered Icons" title: "Taskbar Centered Icons"
description: "Toggles the Taskbar alignment either to the left or center." description: "Toggles the Taskbar alignment either to the left or center."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Taskbar Search Icon" title: "Taskbar Search Icon"
description: "Toggles the Search Button on the Taskbar." description: "Toggles the Search Button on the Taskbar."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Logon Verbose Mode" title: "Logon Verbose Mode"
description: "Show detailed messages during startup/shutdown." description: "Show detailed messages during startup/shutdown."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Window Snapping" title: "Window Snapping"
description: "Toggles the window snapping feature when dragging windows." description: "Toggles the window snapping feature when dragging windows."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Activity History - Disable" title: "Activity History - Disable"
description: "Erases recent docs, clipboard, and run history." description: "Erases recent docs, clipboard, and run history."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "ConsumerFeatures - Disable" title: "ConsumerFeatures - Disable"
description: "Stops promoted app installs and reduces app suggestions from Microsoft Store content." description: "Stops promoted app installs and reduces app suggestions from Microsoft Store content."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Temporary Files - Remove" title: "Temporary Files - Remove"
description: "Erases TEMP Folders." description: "Erases TEMP Folders."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Delivery Optimization - Disable" title: "Delivery Optimization - Disable"
description: "Stops Windows from using your bandwidth to upload updates to other PCs on the internet or local network." description: "Stops Windows from using your bandwidth to upload updates to other PCs on the internet or local network."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "BitLocker - Disable" title: "BitLocker - Disable"
description: "Disables BitLocker." description: "Disables BitLocker."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "File Explorer Automatic Folder Discovery - Disable" title: "File Explorer Automatic Folder Discovery - Disable"
description: "Windows Explorer automatically tries to guess the type of the folder based on its contents, slowing down the browsing experience. WARNING! Will disable File Explorer grouping." description: "Windows Explorer automatically tries to guess the type of the folder based on its contents, slowing down the browsing experience. WARNING! Will disable File Explorer grouping."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Microsoft Store Recommended Search Results - Disable" title: "Microsoft Store Recommended Search Results - Disable"
description: "Will not display recommended Microsoft Store apps when searching for apps in the Start menu." description: "Will not display recommended Microsoft Store apps when searching for apps in the Start menu."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Disk Cleanup - Run" title: "Disk Cleanup - Run"
description: "Runs Disk Cleanup on Drive C: and removes old Windows Updates." description: "Runs Disk Cleanup on Drive C: and removes old Windows Updates."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "End Task With Right Click - Enable" title: "End Task With Right Click - Enable"
description: "Enables option to end task when right clicking a program in the taskbar." description: "Enables option to end task when right clicking a program in the taskbar."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"
@@ -1,10 +1,11 @@
--- ---
title: "Hibernation - Disable" title: "Hibernation - Disable"
description: "Hibernation is really meant for laptops as it saves what's in memory before turning the PC off. It really should never be used." description: "Hibernation is really meant for laptops as it saves what's in memory before turning the PC off. It really should never be used."
editUrl: false
--- ---
:::note :::note
This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Edit the source file and regenerate the docs rather than editing this file directly. This page is generated from [`config/tweaks.json`](https://github.com/ChrisTitusTech/winutil/blob/main/config/tweaks.json). Do not edit this page directly.
::: :::
```json title="config/tweaks.json" ```json title="config/tweaks.json"

Some files were not shown because too many files have changed in this diff Show More