mirror of
https://github.com/ChrisTitusTech/winutil.git
synced 2026-08-09 17:41:14 +10:00
Gave the docs steroids. sorry for the big pr. (#4892)
* Scaffold Astro + Starlight docs site
Bootstraps a new docs-astro project to replace the Hugo-based docs,
using Astro's Starlight framework with the content collection schema
and sidebar navigation configured for WinUtil's docs structure.
* Add WinUtil-branded Starlight theme
Restyles Starlight's default look with a dark-by-default grayscale
palette and WinUtil's brand blue (#0567ff, from the app logo) as the
single accent, Geist for UI text, and JetBrains Mono for code. Also
overrides the default theme provider so first-time visitors land on
dark mode instead of following OS preference.
* Add custom Hero and CornerCard components
Hero overrides Starlight's default hero with a full-bleed grid/glow
background, a browser-chrome-framed screenshot, and a badge row driven
by frontmatter data. CornerCard is a bordered feature card with corner
brackets, used for the landing page's feature grid.
* Migrate docs content from Hugo to Astro/Starlight
Ports the landing page, user guide sections, FAQ, known issues,
contributing guide, and a sample generated tweak reference page from
the Hugo site, converting Hugo shortcodes and GFM alert syntax to
their Starlight/MDX equivalents.
* Use Windows-style caption buttons in hero window chrome
Swap the macOS traffic-light dots for a minimize/maximize/close
button group, since WinUtil is a Windows tool.
* Use Windows-style caption glyph for terminal code blocks
Replace Expressive Code's default macOS dots on terminal-framed code
blocks with a right-aligned Windows minimize/maximize/close icon,
matching the hero window chrome.
* Archive the Hugo docs site as docs-old
* Promote Astro/Starlight docs from docs-astro to docs
* Show the launch command as a copyable code block on the docs homepage
* Add docs codeowner for seanh1995
* Register custom Header component for Starlight docs site
* Add custom navbar links to Astro docs, matching the old Hugo site's top nav
* Point dev docs generator at the Astro/Starlight docs site
Output moves from docs/content/dev (Hugo) to
docs/src/content/docs/code-reference (Astro/Starlight): .mdx instead
of .md, Starlight-style title="..." code fence labels instead of
Hugo's filename/linenos shortcode, and a ":::note" aside linking back
to each entry's source file. Frontmatter description is now pulled
from the JSON Description field. Also fixes a pre-existing bug where
the embedded JSON snippets were always missing their own closing
brace.
* Add seanh1995 as codeowner for the dev docs generator
* Wire up Code Reference section in docs sidebar
Adds an Architecture & Design page plus autogenerated Tweaks/Features
Reference groups pointing at docs/src/content/docs/code-reference, and
fixes the editLink base URL to the promoted docs/ path.
* Port architecture doc to code-reference and drop stale hyperv sample
Moves the Hugo-era architecture doc into
docs/src/content/docs/code-reference/architecture.mdx: drops the
Hugo-only weight/toc frontmatter, converts the embedded code fences to
Starlight's title="..." syntax, and repoints the "Related
Documentation" links at this site's actual slugs. Also removes the
hand-written reference/tweaks/hyperv.mdx placeholder now that the
generator produces the real page under code-reference/features.
* Keep pre-conversion backup of devdocs-generator.ps1
Snapshot of the script before it was pointed at the Astro/Starlight
docs site, for reference.
* updated workflow
* Update CODEOWNERS
* Hide edit-page link on the docs landing page
The splash-template landing page isn't a source doc meant to be edited
via GitHub like the rest of the guides, so skip showing the link.
* Add site footer with copyright line, matching the old Hugo docs
The Hugo site rendered "© {year} Chris Titus Tech. All rights
reserved." in its footer; Starlight's default footer had no
equivalent. Override it to append the same copyright line below the
existing edit-link/pagination row, and collapse that row entirely
when it has nothing in it (e.g. pages with editUrl disabled and no
prev/next) instead of leaving an empty gap.
* Fix vertical alignment and size of the arrow icon in hero/CTA buttons
The right-arrow icon read as floating above the button label's
baseline. Root cause was partly a genuine optical mismatch (fixed with
a small position nudge scoped to just the arrow icon, so it doesn't
also shift the unaffected GitHub icon) and partly the final CTA's copy
getting wrapped in a <p> by MDX's markdown parser, which behaved
slightly differently under the flex layout than the Hero component's
plain text node. Switching the CTA button's label to a JS string
expression avoids the wrapper and keeps both buttons' markup, and
rendering, identical.
* Use the dark fork-button screenshot in the contributing guide
Drop the unused light-mode variant and point the guide at
Fork-Button-Dark.png instead.
* Remove old Hugo docs site and pre-conversion backup files
The docs have moved to the Astro/Starlight site; the Hugo site
(docs-old/), its workflow backup, and the devdocs-generator.ps1
pre-conversion snapshot are no longer needed.
* keeping ai happy
* Bump sharp to 0.35.3 in docs site
This commit is contained in:
Sean (ANGRYxScotsman)
Binary file not shown.
|
After Width: | Height: | Size: 7.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 173 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 194 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 149 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
@@ -0,0 +1,123 @@
|
||||
---
|
||||
// Feature card with small corner brackets instead of a shadow/colored border.
|
||||
import { Icon } from '@astrojs/starlight/components';
|
||||
import type { ComponentProps } from 'astro/types';
|
||||
|
||||
interface Props {
|
||||
icon: ComponentProps<typeof Icon>['name'];
|
||||
title: string;
|
||||
}
|
||||
|
||||
const { icon, title } = Astro.props;
|
||||
---
|
||||
|
||||
<div class="wu-corner-card">
|
||||
<span class="wu-corner-marks" aria-hidden="true">
|
||||
<span class="mark top-left" /><span class="mark top-right" /><span class="mark bottom-left" /><span
|
||||
class="mark bottom-right"
|
||||
/>
|
||||
</span>
|
||||
<div class="wu-corner-card-icon">
|
||||
<Icon name={icon} size="1.25rem" />
|
||||
</div>
|
||||
<h3><slot name="title">{title}</slot></h3>
|
||||
<div class="wu-corner-card-desc"><slot /></div>
|
||||
</div>
|
||||
|
||||
<style>
|
||||
@layer starlight.core {
|
||||
.wu-corner-card {
|
||||
position: relative;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
padding: 1.5rem;
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
background-color: var(--sl-color-bg);
|
||||
}
|
||||
|
||||
.wu-corner-marks {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
pointer-events: none;
|
||||
opacity: 0.5;
|
||||
}
|
||||
.mark {
|
||||
position: absolute;
|
||||
background: var(--sl-color-gray-4);
|
||||
}
|
||||
.mark.top-left,
|
||||
.mark.top-right {
|
||||
top: -1px;
|
||||
height: 1px;
|
||||
width: 0.9rem;
|
||||
}
|
||||
.mark.bottom-left,
|
||||
.mark.bottom-right {
|
||||
bottom: -1px;
|
||||
height: 1px;
|
||||
width: 0.9rem;
|
||||
}
|
||||
.mark.top-left,
|
||||
.mark.bottom-left {
|
||||
left: -1px;
|
||||
}
|
||||
.mark.top-right,
|
||||
.mark.bottom-right {
|
||||
right: -1px;
|
||||
}
|
||||
.mark.top-left::after,
|
||||
.mark.top-right::after,
|
||||
.mark.bottom-left::after,
|
||||
.mark.bottom-right::after {
|
||||
content: '';
|
||||
position: absolute;
|
||||
background: var(--sl-color-gray-4);
|
||||
width: 1px;
|
||||
height: 0.9rem;
|
||||
}
|
||||
.mark.top-left::after,
|
||||
.mark.top-right::after {
|
||||
top: 0;
|
||||
}
|
||||
.mark.bottom-left::after,
|
||||
.mark.bottom-right::after {
|
||||
bottom: 0;
|
||||
}
|
||||
.mark.top-left::after,
|
||||
.mark.bottom-left::after {
|
||||
left: 0;
|
||||
}
|
||||
.mark.top-right::after,
|
||||
.mark.bottom-right::after {
|
||||
right: 0;
|
||||
}
|
||||
|
||||
.wu-corner-card-icon {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 2.5rem;
|
||||
height: 2.5rem;
|
||||
border-radius: var(--wu-radius-sm);
|
||||
background-color: var(--sl-color-gray-6);
|
||||
color: var(--sl-color-accent);
|
||||
}
|
||||
|
||||
.wu-corner-card h3 {
|
||||
margin: 0;
|
||||
font-size: var(--sl-text-lg);
|
||||
font-weight: 600;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
|
||||
.wu-corner-card-desc {
|
||||
font-size: var(--sl-text-sm);
|
||||
line-height: var(--sl-line-height);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.wu-corner-card-desc :global(p) {
|
||||
margin: 0;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
import EditLink from 'virtual:starlight/components/EditLink';
|
||||
import LastUpdated from 'virtual:starlight/components/LastUpdated';
|
||||
import Pagination from 'virtual:starlight/components/Pagination';
|
||||
import config from 'virtual:starlight/user-config';
|
||||
import { Icon } from '@astrojs/starlight/components';
|
||||
|
||||
const year = new Date().getFullYear();
|
||||
---
|
||||
|
||||
<footer class="sl-flex">
|
||||
<div class="meta sl-flex">
|
||||
<EditLink />
|
||||
<LastUpdated />
|
||||
</div>
|
||||
<Pagination />
|
||||
|
||||
{
|
||||
config.credits && (
|
||||
<a class="kudos sl-flex" href="https://starlight.astro.build">
|
||||
<Icon name={'starlight'} /> {Astro.locals.t('builtWithStarlight.label')}
|
||||
</a>
|
||||
)
|
||||
}
|
||||
|
||||
<div class="site-footer-copyright">© {year} <a href="https://christitus.com">Chris Titus Tech</a>. All rights reserved.</div>
|
||||
</footer>
|
||||
|
||||
<style>
|
||||
@layer starlight.core {
|
||||
footer {
|
||||
flex-direction: column;
|
||||
gap: 1.5rem;
|
||||
}
|
||||
.meta {
|
||||
gap: 0.75rem 3rem;
|
||||
justify-content: space-between;
|
||||
flex-wrap: wrap;
|
||||
margin-top: 3rem;
|
||||
font-size: var(--sl-text-sm);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.meta > :global(p:only-child) {
|
||||
margin-inline-start: auto;
|
||||
}
|
||||
|
||||
.kudos {
|
||||
align-items: center;
|
||||
gap: 0.5em;
|
||||
margin: 1.5rem auto;
|
||||
font-size: var(--sl-text-xs);
|
||||
text-decoration: none;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.kudos:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
}
|
||||
|
||||
@layer starlight.components {
|
||||
.kudos :global(svg) {
|
||||
color: var(--sl-color-orange);
|
||||
}
|
||||
}
|
||||
|
||||
/* 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. */
|
||||
footer .meta:empty,
|
||||
footer :global(.pagination-links):empty {
|
||||
display: none;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* Site-wide copyright line, matching the previous Hugo docs site's footer.
|
||||
The divider above it comes from Starlight's own .content-panel border. */
|
||||
.site-footer-copyright {
|
||||
font-size: var(--sl-text-xs);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.site-footer-copyright a {
|
||||
color: inherit;
|
||||
text-decoration: underline;
|
||||
}
|
||||
.site-footer-copyright a:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
</style>
|
||||
@@ -0,0 +1,178 @@
|
||||
---
|
||||
import config from 'virtual:starlight/user-config';
|
||||
|
||||
import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
|
||||
import Search from 'virtual:starlight/components/Search';
|
||||
import SiteTitle from 'virtual:starlight/components/SiteTitle';
|
||||
import SocialIcons from 'virtual:starlight/components/SocialIcons';
|
||||
import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
|
||||
|
||||
/**
|
||||
* Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
|
||||
*/
|
||||
const shouldRenderSearch =
|
||||
config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
|
||||
---
|
||||
|
||||
<div class="header">
|
||||
<div class="title-wrapper sl-flex">
|
||||
<SiteTitle />
|
||||
</div>
|
||||
<div class="sl-flex print:hidden">
|
||||
{shouldRenderSearch && <Search />}
|
||||
</div>
|
||||
<div class="sl-hidden md:sl-flex print:hidden right-group">
|
||||
<nav class="site-nav" aria-label="Top">
|
||||
<a class="site-nav-link" href="/guides/">User Guides</a>
|
||||
<div class="site-nav-dropdown">
|
||||
<button type="button" class="site-nav-link" aria-haspopup="true">Documentation</button>
|
||||
<div class="site-nav-menu">
|
||||
<a href="/contributing/">Contribution Guides</a>
|
||||
<a href="/code-reference/architecture/">Developer Docs</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="site-nav-dropdown">
|
||||
<button type="button" class="site-nav-link" aria-haspopup="true">Help</button>
|
||||
<div class="site-nav-menu">
|
||||
<a href="/faq/">FAQ</a>
|
||||
<a href="/known-issues/">Known Issues</a>
|
||||
<a href="https://forum.christitus.com/" target="_blank" rel="noreferrer">Forums</a>
|
||||
</div>
|
||||
</div>
|
||||
<a class="site-nav-link" href="https://christitus.com/downloads/" target="_blank" rel="noreferrer">Store</a>
|
||||
</nav>
|
||||
<div class="sl-flex social-icons">
|
||||
<SocialIcons />
|
||||
</div>
|
||||
<ThemeSelect />
|
||||
<LanguageSelect />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<style>
|
||||
@layer starlight.core {
|
||||
.header {
|
||||
display: flex;
|
||||
gap: var(--sl-nav-gap);
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.title-wrapper {
|
||||
/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */
|
||||
overflow: clip;
|
||||
/* Avoid clipping focus ring around title wrapper. */
|
||||
padding: 0.25rem;
|
||||
margin: -0.25rem;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.right-group,
|
||||
.social-icons {
|
||||
gap: 1rem;
|
||||
align-items: center;
|
||||
}
|
||||
.social-icons::after {
|
||||
content: '';
|
||||
height: 2rem;
|
||||
border-inline-end: 1px solid var(--sl-color-hairline-light);
|
||||
}
|
||||
|
||||
@media (min-width: 50rem) {
|
||||
:global(:root[data-has-sidebar]) {
|
||||
--__sidebar-pad: calc(2 * var(--sl-nav-pad-x));
|
||||
}
|
||||
:global(:root:not([data-has-toc])) {
|
||||
--__toc-width: 0rem;
|
||||
}
|
||||
.header {
|
||||
--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
|
||||
--__main-column-fr: calc(
|
||||
(
|
||||
100% + var(--__sidebar-pad, 0rem) - var(--__toc-width, var(--sl-sidebar-width)) -
|
||||
(2 * var(--__toc-width, var(--sl-nav-pad-x))) - var(--sl-content-inline-start, 0rem) -
|
||||
var(--sl-content-width)
|
||||
) / 2
|
||||
);
|
||||
display: grid;
|
||||
grid-template-columns:
|
||||
/* 1 (site title): runs up until the main content column’s left edge or the width of the title, whichever is the largest */
|
||||
minmax(
|
||||
calc(var(--__sidebar-width) + max(0rem, var(--__main-column-fr) - var(--sl-nav-gap))),
|
||||
auto
|
||||
)
|
||||
/* 2 (search box): all free space that is available. */
|
||||
1fr
|
||||
/* 3 (right items): use the space that these need. */
|
||||
auto;
|
||||
align-content: center;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/* Top nav links + dropdowns, matching the previous Hugo docs site's navbar. */
|
||||
.site-nav {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 1.25rem;
|
||||
padding-inline-end: 1.25rem;
|
||||
border-inline-end: 1px solid var(--sl-color-hairline-light);
|
||||
}
|
||||
|
||||
.site-nav-link {
|
||||
font-size: var(--sl-text-sm);
|
||||
font-weight: 500;
|
||||
color: var(--sl-color-gray-2);
|
||||
background: none;
|
||||
border: none;
|
||||
padding: 0;
|
||||
font-family: inherit;
|
||||
cursor: pointer;
|
||||
white-space: nowrap;
|
||||
text-decoration: none;
|
||||
}
|
||||
.site-nav-link:hover {
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
|
||||
.site-nav-dropdown {
|
||||
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;
|
||||
margin-bottom: -0.75rem;
|
||||
}
|
||||
.site-nav-menu {
|
||||
display: none;
|
||||
position: absolute;
|
||||
top: 100%;
|
||||
left: 50%;
|
||||
transform: translateX(-50%);
|
||||
min-width: 11rem;
|
||||
padding: 0.5rem;
|
||||
flex-direction: column;
|
||||
gap: 0.125rem;
|
||||
background: var(--sl-color-bg-nav);
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
border-radius: var(--wu-radius-sm, 0.5rem);
|
||||
box-shadow: var(--sl-shadow-lg);
|
||||
z-index: 10;
|
||||
}
|
||||
.site-nav-dropdown:hover .site-nav-menu,
|
||||
.site-nav-dropdown:focus-within .site-nav-menu {
|
||||
display: flex;
|
||||
}
|
||||
.site-nav-menu a {
|
||||
padding: 0.4rem 0.6rem;
|
||||
border-radius: var(--wu-radius-sm, 0.5rem);
|
||||
font-size: var(--sl-text-sm);
|
||||
color: var(--sl-color-gray-2);
|
||||
text-decoration: none;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.site-nav-menu a:hover {
|
||||
color: var(--sl-color-white);
|
||||
background: var(--sl-color-gray-6);
|
||||
}
|
||||
</style>
|
||||
@@ -0,0 +1,294 @@
|
||||
---
|
||||
// Custom hero override: eyebrow, heading, tagline, actions, badges, screenshot.
|
||||
import { Image } from 'astro:assets';
|
||||
import { Icon } from '@astrojs/starlight/components';
|
||||
|
||||
// Matches Starlight's internal PAGE_TITLE_ID (used by the skip-to-content link).
|
||||
const PAGE_TITLE_ID = '_top';
|
||||
|
||||
const { data } = Astro.locals.starlightRoute.entry;
|
||||
const { title = data.title, tagline, image, actions = [] } = data.hero || {};
|
||||
const { heroEyebrow, heroCaption, heroBadges = [] } = data;
|
||||
|
||||
let heroImage: ImageMetadata | undefined;
|
||||
if (image && 'file' in image) heroImage = image.file;
|
||||
---
|
||||
|
||||
<section class="wu-hero">
|
||||
<div class="wu-hero-grid" aria-hidden="true"></div>
|
||||
<div class="wu-hero-glow" aria-hidden="true"></div>
|
||||
<div class="wu-hero-inner">
|
||||
<div class="wu-hero-copy">
|
||||
{heroEyebrow && <p class="wu-eyebrow">{heroEyebrow}</p>}
|
||||
<h1 id={PAGE_TITLE_ID} data-page-title set:html={title} />
|
||||
{tagline && <p class="wu-hero-tagline" set:html={tagline} />}
|
||||
{
|
||||
actions.length > 0 && (
|
||||
<div class="wu-hero-actions">
|
||||
{actions.map(({ icon, link: href, text, variant = 'primary' }) => (
|
||||
<a href={href} class:list={['wu-btn', variant === 'primary' ? 'wu-btn-primary' : 'wu-btn-secondary']}>
|
||||
{text}
|
||||
{icon?.name && (
|
||||
<Icon
|
||||
name={icon.name}
|
||||
size="1.5em"
|
||||
class:list={[(icon.name === 'right-arrow' || icon.name === 'left-arrow') && 'wu-icon-arrow']}
|
||||
/>
|
||||
)}
|
||||
</a>
|
||||
))}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
{heroCaption && <p class="wu-hero-caption">{heroCaption}</p>}
|
||||
</div>
|
||||
{
|
||||
heroImage && (
|
||||
<div class="wu-hero-media">
|
||||
<div class="wu-window">
|
||||
<div class="wu-window-bar">
|
||||
<span class="wu-window-title">winutil.ps1</span>
|
||||
<div class="wu-caption-buttons">
|
||||
<span class="wu-cap-btn wu-cap-min" aria-hidden="true">
|
||||
<svg viewBox="0 0 10 10"><path d="M0 5h10" /></svg>
|
||||
</span>
|
||||
<span class="wu-cap-btn wu-cap-max" aria-hidden="true">
|
||||
<svg viewBox="0 0 10 10"><rect x="0.5" y="0.5" width="9" height="9" /></svg>
|
||||
</span>
|
||||
<span class="wu-cap-btn wu-cap-close" aria-hidden="true">
|
||||
<svg viewBox="0 0 10 10"><path d="M0 0l10 10M10 0L0 10" /></svg>
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
<Image src={heroImage} alt={image?.alt || ''} width={1200} loading="eager" decoding="async" />
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
</div>
|
||||
{
|
||||
heroBadges.length > 0 && (
|
||||
<div class="wu-hero-bottom">
|
||||
<div class="wu-badges">
|
||||
{heroBadges.map(({ src, alt, href }) =>
|
||||
href ? (
|
||||
<a href={href}>
|
||||
<img src={src} alt={alt} />
|
||||
</a>
|
||||
) : (
|
||||
<img src={src} alt={alt} />
|
||||
)
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
</section>
|
||||
|
||||
<style>
|
||||
@layer starlight.core {
|
||||
/* Outer hero shell; pulled up to close Starlight's fixed 1.5rem ContentPanel padding. */
|
||||
.wu-hero {
|
||||
position: relative;
|
||||
border-bottom: 1px solid var(--sl-color-hairline-light);
|
||||
margin-inline: calc(-1 * var(--sl-content-pad-x));
|
||||
padding-inline: var(--sl-content-pad-x);
|
||||
margin-top: -1.5rem;
|
||||
padding-top: 1.5rem;
|
||||
}
|
||||
|
||||
/* Full-bleed grid/glow background, forced behind all hero content via negative z-index. */
|
||||
.wu-hero-grid,
|
||||
.wu-hero-glow {
|
||||
position: absolute;
|
||||
z-index: -1;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
left: 50%;
|
||||
width: 100vw;
|
||||
margin-left: -50vw;
|
||||
pointer-events: none;
|
||||
}
|
||||
|
||||
.wu-hero-grid {
|
||||
background-image:
|
||||
linear-gradient(90deg, var(--sl-color-hairline-light) 1px, transparent 1px),
|
||||
linear-gradient(var(--sl-color-hairline-light) 1px, transparent 1px);
|
||||
background-size: 40px 40px;
|
||||
mask-image: radial-gradient(at top, #000 60%, transparent 100%);
|
||||
-webkit-mask-image: radial-gradient(at top, #000 60%, transparent 100%);
|
||||
opacity: 0.6;
|
||||
}
|
||||
|
||||
.wu-hero-glow {
|
||||
background: radial-gradient(
|
||||
ellipse at center,
|
||||
hsl(var(--wu-accent-h) 100% 61% / 0.14) 0%,
|
||||
hsl(var(--wu-accent-h) 100% 61% / 0.05) 28%,
|
||||
transparent 68%
|
||||
);
|
||||
}
|
||||
|
||||
/* Two-column layout: copy left, screenshot right (stacked on mobile). */
|
||||
.wu-hero-inner {
|
||||
position: relative;
|
||||
z-index: 1;
|
||||
display: grid;
|
||||
gap: 3rem;
|
||||
padding-block: 3rem 2rem;
|
||||
}
|
||||
|
||||
.wu-hero-copy {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.wu-eyebrow {
|
||||
margin: 0 0 1rem;
|
||||
font-size: var(--sl-text-sm);
|
||||
font-weight: 600;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.06em;
|
||||
color: var(--sl-color-accent);
|
||||
}
|
||||
|
||||
.wu-hero-copy h1 {
|
||||
margin: 0;
|
||||
font-size: clamp(var(--sl-text-4xl), calc(0.25rem + 5vw), var(--sl-text-6xl));
|
||||
font-weight: 700;
|
||||
line-height: 1.1;
|
||||
letter-spacing: -0.02em;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
|
||||
.wu-hero-tagline {
|
||||
margin: 1.5rem auto 0;
|
||||
max-width: 40rem;
|
||||
font-size: var(--sl-text-lg);
|
||||
line-height: var(--sl-line-height);
|
||||
color: var(--sl-color-gray-2);
|
||||
}
|
||||
|
||||
.wu-hero-actions {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
justify-content: center;
|
||||
gap: 0.75rem;
|
||||
margin-top: 2.5rem;
|
||||
}
|
||||
|
||||
.wu-hero-caption {
|
||||
margin: 1.5rem 0 0;
|
||||
font-size: var(--sl-text-sm);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
|
||||
/* Screenshot framed in a fake browser window (traffic-light dots + title bar). */
|
||||
.wu-hero-media {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.wu-window {
|
||||
width: 100%;
|
||||
max-width: 56rem;
|
||||
overflow: hidden;
|
||||
border-radius: var(--wu-radius-lg);
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
background: var(--sl-color-gray-6);
|
||||
box-shadow: 0 25px 50px -12px hsl(0 0% 0% / 0.5);
|
||||
}
|
||||
|
||||
.wu-window-bar {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.4rem;
|
||||
padding-inline-start: 0.85rem;
|
||||
border-bottom: 1px solid var(--sl-color-hairline-light);
|
||||
background: var(--sl-color-black);
|
||||
}
|
||||
|
||||
.wu-window-title {
|
||||
font-size: var(--sl-text-xs);
|
||||
color: var(--sl-color-gray-3);
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.wu-caption-buttons {
|
||||
display: flex;
|
||||
height: 2.1rem;
|
||||
}
|
||||
|
||||
.wu-cap-btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 2.75rem;
|
||||
height: 100%;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
|
||||
.wu-cap-btn svg {
|
||||
width: 0.65rem;
|
||||
height: 0.65rem;
|
||||
fill: none;
|
||||
stroke: currentColor;
|
||||
stroke-width: 1;
|
||||
}
|
||||
|
||||
.wu-cap-max svg {
|
||||
fill: none;
|
||||
}
|
||||
|
||||
.wu-cap-close svg {
|
||||
fill: none;
|
||||
}
|
||||
|
||||
.wu-cap-btn:hover {
|
||||
background: var(--sl-color-gray-5);
|
||||
}
|
||||
.wu-cap-close:hover {
|
||||
background: #e81123;
|
||||
color: white;
|
||||
}
|
||||
|
||||
.wu-window :global(img) {
|
||||
display: block;
|
||||
width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
/* Badge row below the two-column layout, centered full-width. */
|
||||
.wu-hero-bottom {
|
||||
position: relative;
|
||||
z-index: 1;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
padding-bottom: 2.5rem;
|
||||
}
|
||||
.wu-hero-bottom .wu-badges {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* Desktop breakpoint: side-by-side columns, left-aligned copy. */
|
||||
@media (min-width: 50rem) {
|
||||
.wu-hero-inner {
|
||||
grid-template-columns: minmax(0, 0.9fr) minmax(0, 1.1fr);
|
||||
align-items: center;
|
||||
gap: 2rem;
|
||||
padding-block: 5rem 3rem;
|
||||
}
|
||||
.wu-hero-copy {
|
||||
text-align: left;
|
||||
}
|
||||
.wu-hero-tagline {
|
||||
margin-inline: 0;
|
||||
}
|
||||
.wu-hero-actions {
|
||||
justify-content: flex-start;
|
||||
}
|
||||
.wu-hero-bottom {
|
||||
padding-bottom: 3rem;
|
||||
}
|
||||
}
|
||||
}
|
||||
</style>
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
// Overrides Starlight's default ThemeProvider: dark by default regardless of OS preference, unless the visitor has explicitly picked a theme before.
|
||||
import { Icon } from '@astrojs/starlight/components';
|
||||
---
|
||||
|
||||
<script is:inline>
|
||||
window.StarlightThemeProvider = (() => {
|
||||
const storedTheme =
|
||||
typeof localStorage !== 'undefined' && localStorage.getItem('starlight-theme');
|
||||
const theme = storedTheme || 'dark';
|
||||
document.documentElement.dataset.theme = theme === 'light' ? 'light' : 'dark';
|
||||
return {
|
||||
updatePickers(theme = storedTheme || 'auto') {
|
||||
document.querySelectorAll('starlight-theme-select').forEach((picker) => {
|
||||
const select = picker.querySelector('select');
|
||||
if (select) select.value = theme;
|
||||
/** @type {HTMLTemplateElement | null} */
|
||||
const tmpl = document.querySelector(`#theme-icons`);
|
||||
const newIcon = tmpl && tmpl.content.querySelector('.' + theme);
|
||||
if (newIcon) {
|
||||
const oldIcon = picker.querySelector('svg.label-icon');
|
||||
if (oldIcon) {
|
||||
oldIcon.replaceChildren(...newIcon.cloneNode(true).childNodes);
|
||||
}
|
||||
}
|
||||
});
|
||||
},
|
||||
};
|
||||
})();
|
||||
</script>
|
||||
|
||||
<template id="theme-icons">
|
||||
<Icon name="sun" class="light" />
|
||||
<Icon name="moon" class="dark" />
|
||||
<Icon name="laptop" class="auto" />
|
||||
</template>
|
||||
@@ -0,0 +1,29 @@
|
||||
import { defineCollection } from 'astro:content';
|
||||
import { z } from 'astro/zod';
|
||||
import { docsLoader } from '@astrojs/starlight/loaders';
|
||||
import { docsSchema } from '@astrojs/starlight/schema';
|
||||
|
||||
export const collections = {
|
||||
docs: defineCollection({
|
||||
loader: docsLoader(),
|
||||
schema: docsSchema({
|
||||
extend: () =>
|
||||
z.object({
|
||||
// Small uppercase kicker line above the hero heading, e.g. "Open Source Windows Setup Utility".
|
||||
heroEyebrow: z.string().optional(),
|
||||
// Muted one-liner below the hero actions, e.g. "Self-hosted. Script-powered. No installer.".
|
||||
heroCaption: z.string().optional(),
|
||||
// Badge images (shields.io, dcbadge, etc.) shown in a row at the bottom of the hero.
|
||||
heroBadges: z
|
||||
.array(
|
||||
z.object({
|
||||
src: z.string(),
|
||||
alt: z.string(),
|
||||
href: z.string().optional(),
|
||||
})
|
||||
)
|
||||
.optional(),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
};
|
||||
@@ -0,0 +1,670 @@
|
||||
---
|
||||
title: Architecture & Design
|
||||
description: How WinUtil's GUI, functions, and JSON configuration files fit together, plus a deep dive into the Win11 Creator subsystem.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
WinUtil is a PowerShell-based Windows utility with a WPF (Windows Presentation Foundation) GUI. This document explains the architecture, code structure, and how different components work together.
|
||||
|
||||
## High-Level Architecture
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ Winutil GUI │
|
||||
│ (WPF XAML Interface) │
|
||||
└──────────────────┬──────────────────────────────────┘
|
||||
│
|
||||
┌─────────┴─────────┐
|
||||
│ │
|
||||
┌────────▼──────┐ ┌───────▼────────┐
|
||||
│ Public APIs │ │ Private APIs │
|
||||
│ (User-facing)│ │ (Internal) │
|
||||
└───────┬───────┘ └───────┬────────┘
|
||||
│ │
|
||||
└────────┬──────────┘
|
||||
│
|
||||
┌────────────▼────────────┐
|
||||
│ Configuration Files │
|
||||
│ (JSON definitions) │
|
||||
└────────────┬────────────┘
|
||||
│
|
||||
┌────────────▼────────────┐
|
||||
│ External Tools │
|
||||
│ (WinGet, Chocolatey) │
|
||||
└─────────────────────────┘
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
### Directory Layout
|
||||
|
||||
```
|
||||
winutil/
|
||||
├── Compile.ps1 # Build script that combines all files
|
||||
├── winutil.ps1 # Compiled output (generated)
|
||||
├── scripts/
|
||||
│ ├── main.ps1 # Entry point and GUI initialization
|
||||
│ └── start.ps1 # Startup logic
|
||||
├── functions/
|
||||
│ ├── private/ # Internal helper functions
|
||||
│ │ ├── Get-WinUtilVariables.ps1
|
||||
│ │ ├── Install-WinUtilWinget.ps1
|
||||
│ │ └── ...
|
||||
│ ├── public/ # User-facing functions
|
||||
│ │ ├── Initialize-WPFUI.ps1
|
||||
│ │ └── ...
|
||||
├── config/ # JSON configuration files
|
||||
│ ├── applications.json # Application definitions
|
||||
│ ├── tweaks.json # Tweak definitions
|
||||
│ ├── feature.json # Windows feature definitions
|
||||
│ └── preset.json # Preset configurations
|
||||
├── xaml/
|
||||
│ └── inputXML.xaml # GUI layout definition
|
||||
└── docs/ # Documentation
|
||||
```
|
||||
|
||||
### Key Components
|
||||
|
||||
#### 1. Compile.ps1
|
||||
**Purpose**: Combines all separate script files into a single `winutil.ps1` for distribution.
|
||||
|
||||
**Process**:
|
||||
1. Reads all function files from `/functions/`
|
||||
2. Includes configuration JSON files
|
||||
3. Embeds XAML GUI definition
|
||||
4. Combines into a single script
|
||||
5. Outputs `winutil.ps1`
|
||||
|
||||
**Why**: Makes distribution easier (single file) and improves load time.
|
||||
|
||||
#### 2. scripts/main.ps1
|
||||
**Purpose**: Entry point that initializes the GUI and event system.
|
||||
|
||||
**Responsibilities**:
|
||||
- Load XAML and create WPF window
|
||||
- Initialize form elements
|
||||
- Set up event handlers
|
||||
- Load configurations
|
||||
- Display the GUI
|
||||
|
||||
#### 3. functions/public/
|
||||
**Purpose**: User-facing functions that implement main features.
|
||||
|
||||
**Key Functions**:
|
||||
- `Initialize-WPFUI.ps1`: Sets up the GUI
|
||||
- `Invoke-WPFTweak*`: Applies system tweaks
|
||||
- `Invoke-WPFFeature*`: Enables Windows features
|
||||
- `Install-WinUtilProgram*`: Installs applications
|
||||
|
||||
**Naming Convention**: Functions start with `WPF` or `Winutil` to be loaded into the runspace.
|
||||
|
||||
#### 4. functions/private/
|
||||
**Purpose**: Internal helper functions not directly called by users.
|
||||
|
||||
**Key Functions**:
|
||||
- `Get-WinUtilVariables.ps1`: Retrieves UI element references
|
||||
- `Install-WinUtilWinget.ps1`: Ensures WinGet is installed
|
||||
- `Get-WinUtilCheckBoxes.ps1`: Gets checkbox states
|
||||
- `Invoke-WinUtilCurrentSystem.ps1`: Gets system information
|
||||
|
||||
#### 5. config/*.json
|
||||
**Purpose**: Define available applications, tweaks, and features declaratively.
|
||||
|
||||
**Files**:
|
||||
- `applications.json`: Application definitions with WinGet/Choco IDs
|
||||
- `tweaks.json`: Registry tweaks and their undo actions
|
||||
- `feature.json`: Windows features that can be enabled/disabled
|
||||
- `preset.json`: Predefined tweak combinations
|
||||
- `dns.json`: DNS provider configurations
|
||||
|
||||
#### 6. xaml/inputXML.xaml
|
||||
**Purpose**: WPF GUI layout and design.
|
||||
|
||||
**Structure**:
|
||||
- Buttons with event handlers
|
||||
- TextBoxes for input
|
||||
- CheckBoxes for options
|
||||
- ListBoxes for selections
|
||||
|
||||
## Win11 Creator Architecture
|
||||
|
||||
The **Win11 Creator** is a specialized subsystem within Winutil that creates customized Windows 11 ISOs. It operates independently from the main package installation and tweak system.
|
||||
|
||||
### Win11 Creator Components
|
||||
|
||||
**Core Functions** (`functions/private/`):
|
||||
- `Invoke-WinUtilISO.ps1`: Main orchestrator containing all Win11 Creator functions
|
||||
- `Invoke-WinUtilISOBrowse`: ISO file selection dialog
|
||||
- `Invoke-WinUtilISOMountAndVerify`: Validates and mounts ISO, verifies it's official Windows 11
|
||||
- `Invoke-WinUtilISOModify`: Launches modification in background runspace
|
||||
- `Invoke-WinUtilISOExport`: Handles ISO and USB export
|
||||
- `Invoke-WinUtilISOCheckExistingWork`: Recovers incomplete work sessions
|
||||
- `Invoke-WinUtilISOCleanAndReset`: Cleans up temp directories and resets UI
|
||||
|
||||
- `Invoke-WinUtilISOScript.ps1`: Applies modifications to mounted install.wim
|
||||
- Removes provisioned AppX packages (40+ bloatware apps)
|
||||
- Injects drivers (optional) from the current system
|
||||
- Removes OneDrive setup files
|
||||
- Applies offline registry tweaks (hardware bypass, privacy, telemetry, OOBE)
|
||||
- Deletes telemetry scheduled task definitions
|
||||
- Pre-stages setup scripts from autounattend.xml
|
||||
- Removes unused Windows editions
|
||||
- Cleans component store via DISM
|
||||
|
||||
### Win11 Creator Data Flow
|
||||
|
||||
```
|
||||
User selects official Windows 11 ISO
|
||||
↓
|
||||
Invoke-WinUtilISOBrowse → OpenFileDialog, validates file size
|
||||
↓
|
||||
Invoke-WinUtilISOMountAndVerify
|
||||
├─ Mount ISO via Mount-DiskImage
|
||||
├─ Verify install.wim or install.esd exists
|
||||
├─ Check for "Windows 11" in image metadata
|
||||
├─ Extract available editions (Home, Pro, Enterprise, etc.)
|
||||
└─ Store ISO path, drive letter, WIM path, image info in $sync
|
||||
↓
|
||||
User optionally enables the Driver Injection checkbox
|
||||
↓
|
||||
Invoke-WinUtilISOModify (runs in background runspace)
|
||||
├─ Create work directory: ~WinUtil_Win11ISO_[timestamp]
|
||||
├─ Copy ISO contents to disk (~5-6 GB)
|
||||
├─ Mount install.wim at selected edition/index
|
||||
├─ Invoke-WinUtilISOScript:
|
||||
│ ├─ Remove 40+ bloat AppX packages
|
||||
│ ├─ Export and inject drivers (if enabled)
|
||||
│ ├─ Remove OneDrive setup
|
||||
│ ├─ Load offline registry hives
|
||||
│ ├─ Apply 50+ registry tweaks (hardware bypass, privacy, telemetry, OOBE, etc.)
|
||||
│ ├─ Delete telemetry scheduled task files
|
||||
│ ├─ Pre-stage setup scripts from autounattend.xml to C:\Windows\Setup\Scripts\
|
||||
│ └─ Unload registry hives
|
||||
├─ DISM /Cleanup-Image /StartComponentCleanup /ResetBase (saves 300-800 MB)
|
||||
├─ Dismount and save the modified install.wim (~10+ minutes, slowest step)
|
||||
├─ Export selected edition only (removes all other editions, saves 1-2 GB each)
|
||||
├─ Dismount source ISO
|
||||
└─ Report completion, enable export options
|
||||
↓
|
||||
Invoke-WinUtilISOExport (user chooses output)
|
||||
├─ Option 1: Save as ISO
|
||||
│ ├─ Build bootable ISO via oscdimg.exe (BIOS/UEFI dual-boot)
|
||||
│ └─ Output: Win11_Modified_[date].iso (2.5-3.5 GB)
|
||||
│
|
||||
└─ Option 2: Write to USB
|
||||
├─ Format USB as GPT
|
||||
├─ Create 512 MB EFI partition
|
||||
├─ Copy modified ISO contents
|
||||
└─ Output: Bootable USB (minimum 8 GB)
|
||||
↓
|
||||
Invoke-WinUtilISOCleanAndReset (optional)
|
||||
└─ Delete temp working directory (~10-15 GB)
|
||||
└─ Reset UI to initial state
|
||||
```
|
||||
|
||||
### Win11 Creator Validation & Safety
|
||||
|
||||
**ISO Validation**:
|
||||
- Only accepts official Microsoft Windows 11 ISOs
|
||||
- Validates presence of install.wim or install.esd
|
||||
- Checks image metadata for "Windows 11" string
|
||||
- Rejects custom, modified, or non-Windows 11 ISOs
|
||||
|
||||
**Work Session Recovery**:
|
||||
- Auto-detects incomplete work from previous sessions
|
||||
- Allows resuming Step 4 (export) without re-running Steps 1-3
|
||||
- Prevents redundant modifications
|
||||
|
||||
**Modification Safety**:
|
||||
- All registry changes are documented in a script (reversible)
|
||||
- Original ISO never modified; only working copy
|
||||
- Logged to `WinUtil_Win11ISO.log` for debugging
|
||||
- DISM handles image dismount with automatic cleanup on error
|
||||
|
||||
### Win11 Creator Registry Tweaks
|
||||
|
||||
The `Invoke-WinUtilISOScript` function applies **50+ offline registry tweaks**:
|
||||
|
||||
**Hardware Bypass**:
|
||||
- TPM 2.0 check bypass
|
||||
- Secure Boot requirement bypass
|
||||
- CPU compatibility bypass
|
||||
- RAM requirement bypass
|
||||
- Storage check bypass
|
||||
|
||||
**Privacy & Telemetry**:
|
||||
- Disable advertising ID
|
||||
- Disable tailored experiences
|
||||
- Disable input personalization
|
||||
- Disable speech online privacy
|
||||
- Disable cloud content suggestions
|
||||
- Disable app suggestion subscriptions
|
||||
- Remove CEIP, Appraiser, WaaSMedic, etc.
|
||||
|
||||
**OOBE & Setup**:
|
||||
- Enable local account setup
|
||||
- Skip Microsoft account requirement
|
||||
- Dark mode by default
|
||||
- Empty taskbar and Start Menu
|
||||
|
||||
**Post-Setup Installations**:
|
||||
- Prevent DevHome auto-installation
|
||||
- Prevent new Outlook Mail app installation
|
||||
- Prevent Teams auto-installation
|
||||
|
||||
**System Features**:
|
||||
- Disable BitLocker and device encryption
|
||||
- Disable Chat icon from the Taskbar
|
||||
- Disable OneDrive folder backup
|
||||
- Disable Copilot
|
||||
- Disable Windows Update during OOBE (re-enabled at first login)
|
||||
|
||||
### Driver Injection Feature
|
||||
|
||||
**Optional Enhancement**: When enabled, exports all drivers from the running system and injects them into both:
|
||||
- `install.wim` (main OS image)
|
||||
- `boot.wim` index 2 (Windows Setup PE environment)
|
||||
|
||||
**Use Case**: Enables offline installation on systems with missing drivers.
|
||||
|
||||
### Disk Space Requirements
|
||||
|
||||
- **Temporary working directory**: ~10-15 GB
|
||||
- **Original ISO**: 4-6 GB
|
||||
- **Modified ISO**: 2.5-3.5 GB
|
||||
- **Total needed**: ~25 GB for safe operation
|
||||
|
||||
## Data Flow
|
||||
|
||||
### Application Installation Flow
|
||||
|
||||
```
|
||||
User clicks "Install"
|
||||
↓
|
||||
Get-WinUtilCheckBoxes → Retrieves selected apps
|
||||
↓
|
||||
For each selected app:
|
||||
↓
|
||||
Check if WinGet/Choco is installed
|
||||
↓
|
||||
Install-WinUtilWinget/Choco (if needed)
|
||||
↓
|
||||
Install-WinUtilProgramWinget/Choco → Install app
|
||||
↓
|
||||
Update UI with progress
|
||||
↓
|
||||
Display completion message
|
||||
```
|
||||
|
||||
### Tweak Application Flow
|
||||
|
||||
```
|
||||
User selects tweaks and clicks "Run Tweaks"
|
||||
↓
|
||||
Get-WinUtilCheckBoxes → Get selected tweaks
|
||||
↓
|
||||
For each selected tweak:
|
||||
↓
|
||||
Load tweak definition from tweaks.json
|
||||
↓
|
||||
Invoke-WPFTweak → Apply registry/service changes
|
||||
↓
|
||||
Log changes
|
||||
↓
|
||||
Store original values (for undo)
|
||||
↓
|
||||
Update UI
|
||||
↓
|
||||
Display completion
|
||||
```
|
||||
|
||||
### Undo Tweak Flow
|
||||
|
||||
```
|
||||
User selects tweaks and clicks "Undo"
|
||||
↓
|
||||
Get-WinUtilCheckBoxes → Get selected tweaks
|
||||
↓
|
||||
For each tweak:
|
||||
↓
|
||||
Retrieve "OriginalState" from tweak definition
|
||||
↓
|
||||
Invoke-WPFUndoTweak → Restore original values
|
||||
↓
|
||||
Remove from the applied tweaks log
|
||||
↓
|
||||
Update UI
|
||||
```
|
||||
|
||||
## Configuration File Format
|
||||
|
||||
### applications.json Structure
|
||||
|
||||
```json title="config/applications.json"
|
||||
{
|
||||
"WPFInstall<AppName>": {
|
||||
"category": "Browsers",
|
||||
"choco": "googlechrome",
|
||||
"content": "Google Chrome",
|
||||
"description": "Google Chrome browser",
|
||||
"link": "https://chrome.google.com",
|
||||
"winget": "Google.Chrome"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fields**:
|
||||
- `category`: Which section in the Install tab
|
||||
- `content`: Display name in GUI
|
||||
- `description`: Tooltip/description text
|
||||
- `winget`: WinGet package ID
|
||||
- `choco`: Chocolatey package name
|
||||
- `link`: Official website
|
||||
|
||||
### tweaks.json Structure
|
||||
|
||||
```json title="config/tweaks.json"
|
||||
{
|
||||
"WPFTweaksTelemetry": {
|
||||
"Content": "Disable Telemetry",
|
||||
"Description": "Disables Microsoft Telemetry",
|
||||
"category": "Essential Tweaks",
|
||||
"panel": "1",
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKLM:\\SOFTWARE\\Policies\\Microsoft\\Windows\\DataCollection",
|
||||
"Name": "AllowTelemetry",
|
||||
"Type": "DWord",
|
||||
"Value": "0",
|
||||
"OriginalValue": "1"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fields**:
|
||||
- `Content`: Display name
|
||||
- `Description`: What it does
|
||||
- `category`: Essential/Advanced/Customize
|
||||
- `registry`: Registry changes to make
|
||||
- `service`: Services to change
|
||||
- `OriginalValue/State`: For undo functionality
|
||||
|
||||
## PowerShell Runspace
|
||||
|
||||
Winutil uses PowerShell runspaces for the GUI to remain responsive:
|
||||
|
||||
```powershell
|
||||
# Create runspace
|
||||
$sync.runspace = [runspacefactory]::CreateRunspace()
|
||||
$sync.runspace.Open()
|
||||
$sync.runspace.SessionStateProxy.SetVariable("sync", $sync)
|
||||
|
||||
# Run code in background
|
||||
$powershell = [powershell]::Create().AddScript($scriptblock)
|
||||
$powershell.Runspace = $sync.runspace
|
||||
$handle = $powershell.BeginInvoke()
|
||||
```
|
||||
|
||||
**Why**: Prevents UI freezing during long-running operations.
|
||||
|
||||
## WPF Event Handling
|
||||
|
||||
Events are wired up via XAML element names:
|
||||
|
||||
```powershell
|
||||
# Get all named elements
|
||||
$sync.keys | ForEach-Object {
|
||||
if($sync.$_.GetType().Name -eq "Button") {
|
||||
$sync.$_.Add_Click({
|
||||
$button = $sync.$($args[0].Name)
|
||||
& "Invoke-$($args[0].Name)"
|
||||
})
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Convention**: Button named `WPFInstallButton` calls function `Invoke-WPFInstallButton`.
|
||||
|
||||
## Package Manager Integration
|
||||
|
||||
### WinGet Integration
|
||||
|
||||
```powershell
|
||||
# Check if installed
|
||||
if (!(Get-Command winget -ErrorAction SilentlyContinue)) {
|
||||
Install-WinUtilWinget
|
||||
}
|
||||
|
||||
# Install package
|
||||
winget install --id $app.winget --silent --accept-source-agreements
|
||||
```
|
||||
|
||||
### Chocolatey Integration
|
||||
|
||||
```powershell
|
||||
# Check if installed
|
||||
if (!(Get-Command choco -ErrorAction SilentlyContinue)) {
|
||||
Install-WinUtilChoco
|
||||
}
|
||||
|
||||
# Install package
|
||||
choco install $app.choco -y
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
Winutil uses PowerShell error handling:
|
||||
|
||||
```powershell
|
||||
try {
|
||||
# Attempt operation
|
||||
Invoke-SomeOperation
|
||||
}
|
||||
catch {
|
||||
Write-Host "Error: $_" -ForegroundColor Red
|
||||
# Log error
|
||||
Add-Content -Path $logfile -Value "ERROR: $_"
|
||||
}
|
||||
```
|
||||
|
||||
**Logging**: Errors and operations are logged for debugging.
|
||||
|
||||
## Configuration Loading
|
||||
|
||||
At startup, Winutil loads all configurations:
|
||||
|
||||
```powershell
|
||||
# Load JSON configs
|
||||
$sync.configs = @{}
|
||||
$sync.configs.applications = Get-Content "config/applications.json" | ConvertFrom-Json
|
||||
$sync.configs.tweaks = Get-Content "config/tweaks.json" | ConvertFrom-Json
|
||||
$sync.configs.features = Get-Content "config/feature.json" | ConvertFrom-Json
|
||||
```
|
||||
|
||||
**Sync Hash**: `$sync` hashtable shares state across runspaces.
|
||||
|
||||
## UI Update Pattern
|
||||
|
||||
UI updates must happen on the UI thread:
|
||||
|
||||
```powershell
|
||||
$sync.form.Dispatcher.Invoke([action]{
|
||||
$sync.WPFStatusLabel.Content = "Installing..."
|
||||
}, "Normal")
|
||||
```
|
||||
|
||||
**Why**: WPF requires UI updates on the main thread.
|
||||
|
||||
## Adding New Features
|
||||
|
||||
### Adding a New Application
|
||||
|
||||
1. Edit `config/applications.json`:
|
||||
```json title="config/applications.json"
|
||||
{
|
||||
"WPFInstallNewApp": {
|
||||
"category": "Utilities",
|
||||
"content": "New App",
|
||||
"description": "Description of new app",
|
||||
"winget": "Publisher.AppName",
|
||||
"choco": "appname"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Recompile: `.\Compile.ps1`
|
||||
3. The app appears automatically in the Install tab
|
||||
|
||||
### Adding a New Tweak
|
||||
|
||||
1. Edit `config/tweaks.json`:
|
||||
```json title="config/tweaks.json"
|
||||
{
|
||||
"WPFTweaksNewTweak": {
|
||||
"Content": "New Tweak",
|
||||
"Description": "What it does",
|
||||
"category": "Essential Tweaks",
|
||||
"registry": [
|
||||
{
|
||||
"Path": "HKLM:\\Path\\To\\Key",
|
||||
"Name": "ValueName",
|
||||
"Type": "DWord",
|
||||
"Value": "1",
|
||||
"OriginalValue": "0"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Recompile: `.\Compile.ps1`
|
||||
3. Tweak appears in the Tweaks tab
|
||||
|
||||
### Adding a New Function
|
||||
|
||||
1. Create file in `functions/public/` or `functions/private/`:
|
||||
```powershell
|
||||
# functions/public/Invoke-WPFNewFeature.ps1
|
||||
function Invoke-WPFNewFeature {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Does something new
|
||||
#>
|
||||
# Implementation
|
||||
}
|
||||
```
|
||||
|
||||
2. File naming must include "WPF" or "Winutil" to load
|
||||
3. Recompile: `.\Compile.ps1`
|
||||
|
||||
## Testing
|
||||
|
||||
### Manual Testing
|
||||
|
||||
```powershell
|
||||
# Compile and run with -run flag
|
||||
.\Compile.ps1 -run
|
||||
```
|
||||
|
||||
### Automated Tests
|
||||
|
||||
Tests are in `/pester/`:
|
||||
- `configs.Tests.ps1`: Validates JSON configurations
|
||||
- `functions.Tests.ps1`: Tests PowerShell functions
|
||||
|
||||
Run tests:
|
||||
```powershell
|
||||
Install-Module -Name Pester -RequiredVersion 5.8.0 -Scope CurrentUser -Force -SkipPublisherCheck
|
||||
Import-Module Pester -RequiredVersion 5.8.0 -Force
|
||||
Invoke-Pester -Path 'pester/*.Tests.ps1' -Output Detailed -CI
|
||||
```
|
||||
|
||||
## Build Process
|
||||
|
||||
### Development Build
|
||||
|
||||
```powershell
|
||||
.\Compile.ps1
|
||||
```
|
||||
|
||||
Outputs `winutil.ps1` in the root directory.
|
||||
|
||||
### Production Release
|
||||
|
||||
1. Tag release in Git
|
||||
2. GitHub Actions builds and uploads `winutil.ps1`
|
||||
3. Release appears on GitHub Releases
|
||||
4. Users download via `irm christitus.com/win`
|
||||
|
||||
## Dependencies
|
||||
|
||||
**Required**:
|
||||
- PowerShell 5.1+
|
||||
- .NET Framework 4.5+
|
||||
- Windows 11
|
||||
|
||||
**Optional (auto-installed)**:
|
||||
- WinGet (Windows Package Manager)
|
||||
- Chocolatey
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
**Optimization Strategies**:
|
||||
- Lazy-load configurations (only when needed)
|
||||
- Use runspaces for long operations
|
||||
- Cache expensive lookups
|
||||
- Minimize registry reads/writes
|
||||
- Batch operations when possible
|
||||
|
||||
## Security Considerations
|
||||
|
||||
**Safety Measures**:
|
||||
- All operations logged
|
||||
- Registry backups for undo
|
||||
- No credential storage
|
||||
- Open source (auditable)
|
||||
- Digitally signed (future)
|
||||
|
||||
## Contributing Guidelines
|
||||
|
||||
**Code Standards**:
|
||||
- Use proper PowerShell cmdlet naming (Verb-Noun)
|
||||
- Include comment-based help
|
||||
- Follow existing code style
|
||||
- Test thoroughly before PR
|
||||
- Document significant changes
|
||||
|
||||
**File Naming**:
|
||||
- Public functions: `Invoke-WPF*.ps1` or `Invoke-Winutil*.ps1`
|
||||
- Private functions: `Get-WinUtil*.ps1` or verb-WinUtil*.ps1`
|
||||
- Must include "WPF" or "Winutil" to load
|
||||
|
||||
## Future Architecture Plans
|
||||
|
||||
**Roadmap Considerations**:
|
||||
- Plugin system for community extensions
|
||||
- Config import/export
|
||||
- Cloud sync for configurations
|
||||
- Enhanced logging dashboard
|
||||
- Modular compilation (choose features)
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Contributing Guide](/contributing/) - How to contribute code
|
||||
- [User Guide](/guides/) - End-user documentation
|
||||
- [Win11 Creator Guide](/guides/win11creator/) - Building customized Windows 11 ISOs
|
||||
- [FAQ](/faq/) - Common questions
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- **GitHub Repository**: [ChrisTitusTech/winutil](https://github.com/ChrisTitusTech/winutil)
|
||||
- **PowerShell Docs**: [Microsoft Docs](https://docs.microsoft.com/powershell/)
|
||||
- **WPF Guide**: [WPF Documentation](https://docs.microsoft.com/dotnet/desktop/wpf/)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: January 2026
|
||||
**Maintainers**: Chris Titus Tech and contributors
|
||||
@@ -0,0 +1,124 @@
|
||||
---
|
||||
title: Contributing
|
||||
description: How to test, report issues, and contribute code to WinUtil.
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
* 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
|
||||
|
||||
```ps1
|
||||
irm https://christitus.com/windev | iex
|
||||
```
|
||||
|
||||
:::caution
|
||||
**Keep in mind** That 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
|
||||
|
||||
* If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs or consider feature requests.
|
||||
|
||||
## Contribute Code
|
||||
|
||||
* Pull requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
|
||||
|
||||
* If you're doing code changes, then you can submit a PR to the `main` branch.
|
||||
|
||||
:::caution
|
||||
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!
|
||||
:::
|
||||
|
||||
:::caution
|
||||
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.
|
||||
|
||||
* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
|
||||
|
||||
:::note
|
||||
When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
|
||||
:::
|
||||
|
||||
## Walk through
|
||||
|
||||
* This is a guide for beginners. If you are still having issues, look at the following official GitHub documentation:
|
||||
* [Commit through WEB](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)
|
||||
* [Commit through GitHub Desktop](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)
|
||||
* [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
||||
|
||||
|
||||
### Overview
|
||||
|
||||
```mermaid
|
||||
%%{init: {"flowchart": {"curve": "cardinal"}} }%%
|
||||
graph TD
|
||||
A[Fork Project] --> B[Clone Repository];
|
||||
B --> C[Create New Branch];
|
||||
C --> D[Make Changes];
|
||||
D --> G[Test Changes];
|
||||
G --> H{Tests Passed?};
|
||||
H -->|Yes| E[Commit Changes];
|
||||
H -->|No| J[Fix Issues];
|
||||
J --> G;
|
||||
E --> F[Push Branch];
|
||||
F --> K[Create Pull Request];
|
||||
K --> L[Fill out PR template];
|
||||
classDef default stroke:#333,stroke-width:4px,font-size:12pt;
|
||||
```
|
||||
|
||||
:::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 WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
|
||||
|
||||
|
||||
|
||||
### Clone the Fork
|
||||
:::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.
|
||||
:::
|
||||
|
||||
* Install GitHub Desktop if it is not already installed.
|
||||
* Log in using the same GitHub account you used to fork WinUtil.
|
||||
* Choose the fork under "Your Repositories" and press "clone `{repo name}`"
|
||||
* Create a new branch and name it something relatable to your changes.
|
||||
|
||||
* Now you can modify WinUtil to your liking using your preferred text editor.
|
||||
|
||||
|
||||
### Testing your changes
|
||||
|
||||
* To test to see if your changes work as intended, run the following commands in a PowerShell terminal as admin:
|
||||
|
||||
* Change the directory where you are running the commands to the forked project.
|
||||
* `cd {path to the folder with the compile.ps1}`
|
||||
* Run the following command to compile and run WinUtil:
|
||||
* `.\Compile.ps1 -run`
|
||||
|
||||
|
||||
|
||||
* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
|
||||
|
||||
### Committing the changes
|
||||
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
|
||||
|
||||
|
||||
|
||||
* Now, commit your changes once you are happy with the result.
|
||||
|
||||
|
||||
|
||||
* Push the changes to upload them to your fork on github.com.
|
||||
|
||||
|
||||
|
||||
### 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.
|
||||
* If you do not see your feature in the main "/win" build, that is fine. All new changes go into the /windev build to make sure everything is working OK before going fully public.
|
||||
* Congratulations! You just submitted your first PR. Thank you so much for contributing to WinUtil.
|
||||
@@ -0,0 +1,321 @@
|
||||
---
|
||||
title: Frequently Asked Questions
|
||||
description: Common questions about installing, running, and troubleshooting WinUtil.
|
||||
---
|
||||
|
||||
## General questions
|
||||
|
||||
### Is Windows 10 still supported?
|
||||
|
||||
No. Windows 10 is no longer supported by WinUtil because it reached the end of support on **October 14, 2025**. WinUtil is focused on Windows 11.
|
||||
|
||||
### How do I uninstall WinUtil?
|
||||
|
||||
You do not need to uninstall WinUtil. Because it runs as a PowerShell script, it is loaded into memory only while it is open. Once you close it, it is removed from memory and does not remain installed on your system.
|
||||
|
||||
### Is WinUtil safe to use?
|
||||
|
||||
Yes, WinUtil is open source, and the code is publicly available on GitHub. Thousands of users run it daily. However, like any system modification tool, you should:
|
||||
|
||||
- Run it as Administrator (required)
|
||||
- Create a restore point before major changes
|
||||
- Understand what tweaks you're applying
|
||||
- Run only from the [official source](https://github.com/ChrisTitusTech/winutil/)
|
||||
|
||||
### Do I need to keep running WinUtil?
|
||||
|
||||
No. Once you've applied tweaks or installed applications, you can close WinUtil. Changes persist after closing. You only need to run WinUtil again when you want to make additional changes or undo tweaks.
|
||||
|
||||
### Does WinUtil require internet access?
|
||||
|
||||
- **For downloading**: Yes, installing applications requires the internet
|
||||
- **For tweaks**: No, most tweaks work offline
|
||||
- **Initial run**: Yes, to run the latest script
|
||||
|
||||
### How often is WinUtil updated?
|
||||
|
||||
WinUtil is actively maintained with frequent updates. New features, bug fixes, and application additions are released regularly. The script auto-downloads the latest version each time you run it.
|
||||
|
||||
## Installation & running
|
||||
|
||||
### How do I run WinUtil?
|
||||
|
||||
1. Open PowerShell as Administrator
|
||||
2. Run: `irm "https://christitus.com/win" | iex`
|
||||
3. Wait for the GUI to appear
|
||||
|
||||
### Why do I need Administrator rights?
|
||||
|
||||
WinUtil makes system-level changes (registry edits, service modifications, software installation) that require elevated permissions. Without admin rights, most features won't work.
|
||||
|
||||
### The script won't download. What do I do?
|
||||
|
||||
Try these solutions in order:
|
||||
|
||||
1. **Use the direct GitHub link**:
|
||||
|
||||
```powershell
|
||||
irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/Winutil.ps1 | iex
|
||||
```
|
||||
|
||||
2. **Force TLS 1.2**:
|
||||
|
||||
```powershell
|
||||
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
|
||||
irm "https://christitus.com/win" | iex
|
||||
```
|
||||
|
||||
:::note
|
||||
On Windows 11, you usually do not need the TLS 1.2 command. Use it only if you encounter download or security protocol errors.
|
||||
:::
|
||||
|
||||
3. **Change DNS** to Cloudflare (1.1.1.1) or Google (8.8.8.8)
|
||||
4. **Use a VPN** if GitHub is blocked in your region
|
||||
|
||||
### I get an "Execution Policy" error. How do I fix it?
|
||||
|
||||
Run this command first to allow script execution:
|
||||
|
||||
```powershell
|
||||
Set-ExecutionPolicy Unrestricted -Scope Process -Force
|
||||
irm "https://christitus.com/win" | iex
|
||||
```
|
||||
|
||||
This only affects the current PowerShell session and is safe.
|
||||
|
||||
## Tweaks & modifications
|
||||
|
||||
### I applied a tweak and now something doesn't work. What do I do?
|
||||
|
||||
If you applied a tweak and it breaks something, you can revert it:
|
||||
|
||||
1. Open WinUtil again
|
||||
2. Go to the **Tweaks** tab
|
||||
3. Select the same tweak you applied
|
||||
4. Click **Undo Selected Tweaks**
|
||||
5. The system will revert to the previous state
|
||||
|
||||
Alternatively, use System Restore if you created a restore point.
|
||||
|
||||
### Which tweaks are safe to apply?
|
||||
|
||||
**Safe for everyone (Essential Tweaks)**:
|
||||
|
||||
- Disable Telemetry
|
||||
- Disable Activity History
|
||||
- Disable Location Tracking
|
||||
- Delete Temporary Files
|
||||
- Run Disk Cleanup
|
||||
- Create Restore Point
|
||||
|
||||
**Advanced Tweaks** should only be run by advanced users.
|
||||
|
||||
### Will tweaks survive Windows Updates?
|
||||
|
||||
Most tweaks persist through updates, but some may be reset by major Windows feature updates. You may need to reapply certain tweaks afterwards.
|
||||
|
||||
### Can I create my own tweak presets?
|
||||
|
||||
Currently, WinUtil uses predefined presets (Standard, Minimal). Custom presets aren't directly supported in the GUI, but you can script your preferred configuration.
|
||||
|
||||
### What's the difference between Essential and Advanced tweaks?
|
||||
|
||||
- **Essential Tweaks**: Safe for most users, improve performance/privacy with minimal risk
|
||||
- **Advanced Tweaks**: More aggressive changes that may break functionality or compatibility. Use with caution.
|
||||
|
||||
## Application installation
|
||||
|
||||
### How does WinUtil install applications?
|
||||
|
||||
WinUtil uses Windows Package Manager (WinGet) and Chocolatey to automate installations. It downloads applications from official sources and installs them silently without bloatware.
|
||||
|
||||
### Can I install multiple applications at once?
|
||||
|
||||
Yes! Check the boxes for all applications you want, then click "Install Selected". They'll install sequentially.
|
||||
|
||||
### WinGet isn't working. How do I fix it?
|
||||
|
||||
1. Go to the **Config** tab
|
||||
2. Find the **Fixes** section
|
||||
3. Click **WinGet Reinstall**
|
||||
4. Wait for completion
|
||||
5. Try installing applications again
|
||||
|
||||
### Do installed applications have bloatware or bundled software?
|
||||
|
||||
No. WinGet and Chocolatey install clean versions of applications without bundled offers, toolbars, or bloatware.
|
||||
|
||||
### Can I uninstall applications through WinUtil?
|
||||
|
||||
WinUtil primarily focuses on installing and managing applications rather than providing a full GUI for uninstalling every program. To remove applications you can:
|
||||
|
||||
- Use Windows Settings > Apps > Installed apps to uninstall programs.
|
||||
- Use package manager commands in PowerShell (for example `winget uninstall <package>` or `choco uninstall <package>`).
|
||||
- Some packages installed by WinUtil (AppX/MSIX) include removal helpers; check the app entry or use WinUtil's remove helpers when available.
|
||||
|
||||
### Will installed apps auto-update?
|
||||
|
||||
Applications with built-in update mechanisms will auto-update. You can also update them via WinGet/Chocolatey commands or through WinUtil's "Upgrade Selected" feature.
|
||||
|
||||
## Updates & maintenance
|
||||
|
||||
### Should I disable Windows Updates?
|
||||
|
||||
Generally, **no**. Security updates are important. However, you might:
|
||||
|
||||
- Use "Security Updates Only" to avoid feature updates
|
||||
- Pause updates temporarily for stability
|
||||
- Disable only during critical work periods
|
||||
|
||||
### How do I re-enable updates after disabling them?
|
||||
|
||||
1. Open WinUtil
|
||||
2. Go to the **Updates** tab
|
||||
3. Click **Default Updates**
|
||||
4. Updates will resume normally
|
||||
|
||||
### What's the difference between "Security Updates Only" and "Disable Updates"?
|
||||
|
||||
- **Security Updates Only**: Installs critical security patches, blocks feature updates (major versions)
|
||||
- **Disable Updates**: Blocks ALL updates including security (not recommended)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### WinUtil won't open after running the command
|
||||
|
||||
Possible causes:
|
||||
|
||||
1. **Antivirus blocking**: Add PowerShell exception
|
||||
2. **Not run as Admin**: Restart PowerShell as Administrator
|
||||
3. **Corrupted download**: Close PowerShell, reopen, try again
|
||||
4. **Windows Defender**: Allow the script
|
||||
|
||||
### My antivirus flags WinUtil as malicious
|
||||
|
||||
This is a false positive. WinUtil makes system changes that antivirus programs may flag. The code is open source and audited. Add an exception if needed.
|
||||
|
||||
### An application failed to install
|
||||
|
||||
Troubleshooting steps:
|
||||
|
||||
1. Check your internet connection
|
||||
2. Try installing just that one application
|
||||
3. Review error messages in the output panel
|
||||
4. Check if the antivirus is blocking
|
||||
5. Try the WinGet Reinstall fix
|
||||
|
||||
### Network tweaks broke my internet connection
|
||||
|
||||
1. Open WinUtil
|
||||
2. Go to **Config** > **Fixes**
|
||||
3. Click **Reset Network**
|
||||
4. Restart your computer
|
||||
5. Connection should be restored
|
||||
|
||||
### I can't access certain Windows features after applying tweaks
|
||||
|
||||
Undo the tweaks that might have affected those features:
|
||||
|
||||
1. Reopen WinUtil
|
||||
2. Select the tweaks you applied
|
||||
3. Click **Undo Selected Tweaks**
|
||||
|
||||
If that doesn't work, use System Restore to revert to a previous state.
|
||||
|
||||
## Advanced topics
|
||||
|
||||
### Can I run WinUtil on Windows Server?
|
||||
|
||||
Yes, WinUtil works on Windows Server editions, though some features may not be applicable or may behave differently.
|
||||
|
||||
### Does WinUtil work with Windows LTSC?
|
||||
|
||||
Yes, WinUtil works with Windows 10/11 LTSC editions. Some applications may not be available depending on your configuration.
|
||||
|
||||
### Can I use WinUtil in a corporate/enterprise environment?
|
||||
|
||||
Yes, but check your organization's policies first. Some tweaks may conflict with Group Policy or other corporate requirements.
|
||||
|
||||
### How do I automate WinUtil for multiple PCs?
|
||||
|
||||
See the [Automation Guide](/guides/automation/) for details on:
|
||||
|
||||
- Configuration files
|
||||
- PowerShell parameters
|
||||
- Batch deployment
|
||||
- Silent installation
|
||||
|
||||
### Can I contribute to WinUtil?
|
||||
|
||||
Yes! Contributions are welcome:
|
||||
|
||||
- Report bugs on GitHub Issues
|
||||
- Submit pull requests for fixes/features
|
||||
- Improve documentation
|
||||
- Help others in Discord
|
||||
|
||||
See the [Contributing Guide](/contributing/) for details.
|
||||
|
||||
## Privacy & security
|
||||
|
||||
### Does WinUtil collect any data?
|
||||
|
||||
No, WinUtil itself doesn't collect or transmit any user data. It's a local PowerShell script.
|
||||
|
||||
### What telemetry does the Disable Telemetry tweak block?
|
||||
|
||||
It disables:
|
||||
|
||||
- Windows diagnostic data collection
|
||||
- Activity history tracking
|
||||
- Feedback requests
|
||||
- Usage statistics
|
||||
- Error reporting (optional)
|
||||
|
||||
### Will removing Microsoft Store affect security updates?
|
||||
|
||||
No, Windows security updates are independent of the Microsoft Store.
|
||||
|
||||
## Performance
|
||||
|
||||
### Will WinUtil make my PC faster?
|
||||
|
||||
Tweaks can improve performance by:
|
||||
|
||||
- Reducing background processes
|
||||
- Disabling unnecessary services
|
||||
- Cleaning temporary files
|
||||
- Optimizing startup programs
|
||||
|
||||
Results may vary depending on your system.
|
||||
|
||||
### What's the best preset for gaming?
|
||||
|
||||
Use the **Desktop** preset, then additionally apply:
|
||||
|
||||
- Disable GameDVR
|
||||
- Ultimate Performance power plan
|
||||
- Disable full-screen optimizations (Advanced)
|
||||
- Set display for performance (Advanced)
|
||||
|
||||
### How much RAM does WinUtil use?
|
||||
|
||||
WinUtil itself uses about 50-100 MB while running. Once closed, it is removed from memory.
|
||||
|
||||
## Error messages
|
||||
|
||||
### "Access Denied" errors
|
||||
|
||||
- Ensure PowerShell is running as Administrator
|
||||
- Check if the antivirus is blocking changes
|
||||
- Verify you have ownership of files/registry keys
|
||||
|
||||
## Still need help?
|
||||
|
||||
Can't find your answer? Try these resources:
|
||||
|
||||
- **[Known Issues](/known-issues/)** — Check if it's a known problem
|
||||
- **[User Guide](/guides/getting-started/)** — Comprehensive documentation
|
||||
- **[Discord Community](https://discord.gg/RUbZUZyByQ)** — Get help from other users
|
||||
- **[GitHub Issues](https://github.com/ChrisTitusTech/winutil/issues)** — Report bugs
|
||||
- **[YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)** — Video walkthrough
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Applications
|
||||
description: Use the Applications tab in WinUtil to install, upgrade, uninstall, and review supported apps.
|
||||
sidebar:
|
||||
order: 2
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components';
|
||||
|
||||
Use the Applications tab to install, upgrade, uninstall, and review supported apps from one place. WinUtil relies on package manager support for these actions, so the available results depend on what WinGet can detect and manage on your system.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Installation & Updates">
|
||||
* Choose the applications you want to install or upgrade.
|
||||
* For programs not currently installed, this action will install them.
|
||||
* For programs already installed, this action will update them to the latest version.
|
||||
* Click the `Install/Upgrade Selected` button to start the installation or upgrade process.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Upgrade All">
|
||||
* Simply press the `Upgrade All` button.
|
||||
* This upgrades every supported installed program without individual selection.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Uninstall">
|
||||
* Select the programs you wish to uninstall.
|
||||
* Click the `Uninstall Selected` button to remove them.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Show Installed Apps">
|
||||
* Click the `Show Installed Apps` button.
|
||||
* This scans for and selects installed applications supported by WinGet.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem label="Clear Selection">
|
||||
* Click the `Clear Selection` button.
|
||||
* This clears all current selections.
|
||||
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip
|
||||
If you have trouble finding an application, press `Ctrl + F` and search for its name. The list filters as you type.
|
||||
:::
|
||||
|
||||
:::note
|
||||
`Show Installed Apps` only selects software that WinGet can identify. Apps installed outside supported package sources may not appear.
|
||||
:::
|
||||
|
||||
:::caution
|
||||
Before uninstalling or upgrading apps, close any running programs first. Some packages may still prompt for input or fail if their source is unavailable.
|
||||
:::
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Automation
|
||||
description: Run WinUtil from an exported configuration file or a preset to automate setups across multiple PCs.
|
||||
sidebar:
|
||||
order: 6
|
||||
---
|
||||
|
||||
Use Automation to run WinUtil from an exported configuration file.
|
||||
|
||||
WinUtil supports predefined presets that apply common configurations automatically:
|
||||
|
||||
- `Standard`
|
||||
- `Minimal`
|
||||
- `Advanced`
|
||||
|
||||
Example:
|
||||
|
||||
```powershell
|
||||
& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Preset Standard
|
||||
```
|
||||
|
||||
To view exactly what each preset does, see:
|
||||
https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json
|
||||
|
||||
To create your own config file:
|
||||
|
||||
1. Open WinUtil.
|
||||
2. Click the gear icon in the top-right corner.
|
||||
3. Choose **Export**.
|
||||
4. Save the exported JSON file.
|
||||
|
||||
Once you have exported a config, launch WinUtil with it using this command:
|
||||
```powershell
|
||||
& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Config "C:\Path\To\Config.json"
|
||||
```
|
||||
|
||||
This is useful for:
|
||||
|
||||
- Applying the same WinUtil configuration across multiple Windows 11 PCs
|
||||
- Reusing a known-good baseline after reinstalling Windows
|
||||
- Standardizing deployments for labs, workstations, or personal setups
|
||||
|
||||
:::note
|
||||
Run the command in an elevated PowerShell session so WinUtil can apply system-level changes.
|
||||
:::
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Features
|
||||
description: Install optional Windows components and run common repair tasks from the Features and Fixes sections.
|
||||
sidebar:
|
||||
order: 4
|
||||
---
|
||||
|
||||
Use the **Features** and **Fixes** sections to install optional Windows components and run common repair tasks.
|
||||
|
||||
This page maps to the **Config** tab in WinUtil. Some actions complete immediately, while others may prompt, download files from Microsoft, or require a restart before the change is fully available.
|
||||
|
||||
|
||||
|
||||
## Windows Features
|
||||
|
||||
Install common **Windows features** by selecting the feature checkboxes and clicking **Install Features**.
|
||||
|
||||
If a feature depends on Windows installation media or optional downloads, Windows may take longer to finish or request a reboot.
|
||||
|
||||
* All .NET Frameworks (2, 3, 4)
|
||||
* Hyper-V Virtualization
|
||||
* Legacy Media (WMP, DirectPlay)
|
||||
* NFS - Network File System
|
||||
* Enable Daily Registry Backup Task 12:30 AM
|
||||
* Enable Legacy F8 Boot Recovery
|
||||
* Disable Legacy F8 Boot Recovery
|
||||
* Windows Subsystem for Linux
|
||||
* Windows Sandbox
|
||||
|
||||
## Fixes
|
||||
|
||||
Use these one-click fixes for common system problems.
|
||||
|
||||
Use these when you have a specific issue to correct, not as a routine cleanup step.
|
||||
|
||||
* Set Up Autologin
|
||||
* Reset Windows Update
|
||||
* Reset Network
|
||||
* System Corruption Scan
|
||||
* WinGet Reinstall
|
||||
|
||||
## Legacy Windows Panels
|
||||
|
||||
Open old-school Windows panels directly from WinUtil. Available panels include:
|
||||
|
||||
* Control Panel
|
||||
* Network Connections
|
||||
* Power Panel
|
||||
* Region
|
||||
* Sound Settings
|
||||
* System Properties
|
||||
* User Accounts
|
||||
|
||||
## Remote Access
|
||||
|
||||
Enable an OpenSSH server on your Windows machine for remote access.
|
||||
|
||||
Only enable this if you intend to use remote shell access. After turning it on, verify your firewall rules and account permissions before exposing the machine to other devices.
|
||||
@@ -0,0 +1,259 @@
|
||||
---
|
||||
title: Getting Started
|
||||
description: The safest way to get started with WinUtil and the first actions most users take.
|
||||
sidebar:
|
||||
order: 1
|
||||
---
|
||||
|
||||
## Welcome to WinUtil!
|
||||
|
||||
WinUtil helps you install apps, apply system tweaks, run common fixes, and manage Windows settings from one place. This guide covers the safest way to get started and the first actions most users take.
|
||||
|
||||
## System requirements
|
||||
|
||||
Before running WinUtil, ensure your system meets these requirements:
|
||||
|
||||
:::caution
|
||||
Windows 10 is not supported by WinUtil. Windows 10 reached the end of support on **October 14, 2025**.
|
||||
:::
|
||||
|
||||
- **Operating system**: Windows 11
|
||||
- **PowerShell**: Version 5.1 or later (included by default in Windows 11)
|
||||
- **Administrator access**: Required for system-level changes
|
||||
- **Internet connection**: Required for downloading applications and updates
|
||||
- **.NET Framework**: Version 4.5 or later (usually pre-installed)
|
||||
|
||||
## Installation
|
||||
|
||||
WinUtil doesn't require traditional installation. It runs directly from PowerShell as a script.
|
||||
|
||||
### Step 1: Open PowerShell as Administrator
|
||||
|
||||
There are several ways to open PowerShell with admin rights:
|
||||
|
||||
**Method 1: Start menu (recommended)**
|
||||
|
||||
1. Right-click the Windows Start button.
|
||||
2. Select "Terminal (Admin)".
|
||||
|
||||
**Method 2: Search method**
|
||||
|
||||
1. Press the `Windows` key.
|
||||
2. Type "PowerShell" or "Terminal".
|
||||
3. Press `Ctrl + Shift + Enter` to launch as administrator.
|
||||
4. Or right-click and select "Run as administrator".
|
||||
|
||||
**Method 3: Run dialog**
|
||||
|
||||
1. Press `Windows + R`.
|
||||
2. Type `powershell`.
|
||||
3. Press `Ctrl + Shift + Enter`.
|
||||
|
||||
### Step 2: Run the launch command
|
||||
|
||||
With PowerShell running as Administrator, run one of the following commands depending on the release channel you want.
|
||||
|
||||
**Stable release (recommended)**
|
||||
|
||||
```powershell
|
||||
irm "https://christitus.com/win" | iex
|
||||
```
|
||||
|
||||
**Development branch (bleeding edge — for testing only)**
|
||||
|
||||
```powershell
|
||||
irm "https://christitus.com/windev" | iex
|
||||
```
|
||||
|
||||
:::note
|
||||
- The `irm` command downloads the script, and `iex` executes it. This is safe when downloading from the official source.
|
||||
- The development branch may contain experimental changes and should only be used for testing on non-production systems.
|
||||
:::
|
||||
|
||||
### Step 3: Wait for WinUtil to load
|
||||
|
||||
The first time you run WinUtil, it may take a few moments to:
|
||||
|
||||
- Download the latest version
|
||||
- Initialize the interface
|
||||
- Load all features and settings
|
||||
|
||||
## First time setup
|
||||
|
||||
### Understanding the interface
|
||||
|
||||
WinUtil opens with a clean, tabbed interface:
|
||||
|
||||
**Main tabs**:
|
||||
|
||||
- **Install**: Browse and install applications
|
||||
- **Tweaks**: Apply system optimizations and customizations
|
||||
- **Config**: Access system tools and utilities
|
||||
- **Updates**: Manage Windows updates
|
||||
- **Win11 Creator**: Build a customized Windows 11 ISO from an official Microsoft image
|
||||
|
||||
## Your first actions
|
||||
|
||||
Here are some recommended first steps for new users:
|
||||
|
||||
### 1. Create a restore point
|
||||
|
||||
Before making any changes, create a system restore point:
|
||||
|
||||
1. Go to the **Tweaks** tab.
|
||||
2. Find "Create Restore Point" under Essential Tweaks.
|
||||
3. Check the box and click **Run Tweaks**.
|
||||
|
||||
This gives you a rollback point if needed.
|
||||
|
||||
### 2. Install essential applications
|
||||
|
||||
1. Navigate to the **Install** tab.
|
||||
2. Browse categories or use the search bar.
|
||||
3. Check the applications you want to install.
|
||||
4. Click "Install/Upgrade Selected" at the bottom.
|
||||
|
||||
### 3. Apply basic tweaks
|
||||
|
||||
For a better Windows experience with minimal risk:
|
||||
|
||||
1. Go to the **Tweaks** tab.
|
||||
2. Select the **Standard** preset for a balanced configuration.
|
||||
3. Review the selected tweaks.
|
||||
4. Click **Run Tweaks**.
|
||||
|
||||
:::note
|
||||
Some tweaks, fixes, and update changes may require a restart or sign-out before the full effect is visible.
|
||||
:::
|
||||
|
||||
## Common tasks
|
||||
|
||||
### Installing applications
|
||||
|
||||
**Single application**:
|
||||
|
||||
1. Open the **Install** tab.
|
||||
2. Search for the application name.
|
||||
3. Check the box next to it.
|
||||
4. Click "Install/Upgrade Selected".
|
||||
|
||||
**Multiple applications**:
|
||||
|
||||
1. Check multiple application boxes.
|
||||
2. All checked apps will install in sequence.
|
||||
3. Install and uninstall progress is shown in the window-level bottom panel, including the current package or package-manager batch and overall completion.
|
||||
|
||||
### Applying tweaks
|
||||
|
||||
**Essential tweaks** (safe for all users):
|
||||
|
||||
1. Go to the **Tweaks** tab.
|
||||
2. Select from the Essential Tweaks section.
|
||||
3. Click **Run Tweaks**.
|
||||
|
||||
**Advanced tweaks** (use with caution):
|
||||
|
||||
1. Only modify if you understand the implications.
|
||||
2. Always create a restore point first.
|
||||
3. Review documentation for each tweak.
|
||||
|
||||
**Undoing tweaks**:
|
||||
|
||||
1. Select the same tweaks you applied.
|
||||
2. Click **Undo Selected Tweaks**.
|
||||
3. The system reverts to the previous state.
|
||||
|
||||
### Using quick fixes
|
||||
|
||||
For common Windows issues:
|
||||
|
||||
1. Go to the **Config** tab.
|
||||
2. Navigate to the **Fixes** section.
|
||||
3. Select the appropriate fix:
|
||||
- **Reset Network**: Fixes network connectivity issues
|
||||
- **Reset Windows Update**: Resolves update problems
|
||||
- **System Corruption Scan**: Repairs corrupted system files
|
||||
- **WinGet Reinstall**: Fixes package manager issues
|
||||
|
||||
### Changing DNS servers
|
||||
|
||||
For improved privacy and speed:
|
||||
|
||||
1. Go to the **Tweaks** tab.
|
||||
2. Find the DNS section.
|
||||
3. Select a provider:
|
||||
- **Cloudflare**: Fast and privacy-focused
|
||||
- **Google**: Reliable and widely used
|
||||
- **Quad9**: Security-focused with malware blocking
|
||||
- **AdGuard**: Blocks ads and trackers
|
||||
4. Click **Apply**.
|
||||
|
||||
## Understanding presets
|
||||
|
||||
WinUtil offers several preset configurations:
|
||||
|
||||
- **Minimal**: Minimal changes that keep most Windows features
|
||||
- **Standard**: A good middle ground for most users
|
||||
- **Advanced**: Selects a focused set of safer advanced tweaks
|
||||
|
||||
## Safety tips
|
||||
|
||||
✅ **Do**:
|
||||
|
||||
- Create restore points before major changes
|
||||
- Read tweak descriptions before applying
|
||||
- Start with Essential Tweaks
|
||||
- Keep Windows up to date
|
||||
- Back up important data
|
||||
|
||||
❌ **Don't**:
|
||||
|
||||
- Apply all tweaks at once without understanding them
|
||||
- Skip creating restore points
|
||||
- Use Advanced Tweaks without research
|
||||
- Disable security features unless necessary
|
||||
- Run on production systems without testing
|
||||
|
||||
## Troubleshooting first run
|
||||
|
||||
### Script won't download
|
||||
|
||||
If the launch command fails:
|
||||
|
||||
- Make sure PowerShell or Terminal is running as Administrator.
|
||||
- Confirm the PC has internet access and can reach `christitus.com`.
|
||||
- Retry from a normal PowerShell session rather than a restricted enterprise shell profile.
|
||||
- If the command starts and then closes immediately, reopen Terminal as Administrator and run it again so you can read the error output.
|
||||
|
||||
If it still fails, check the [Known Issues](/known-issues/) page.
|
||||
|
||||
## Next steps
|
||||
|
||||
Now that you're set up, explore these guides:
|
||||
|
||||
- [Applications Guide](/guides/application/) — Learn about installing, upgrading, and uninstalling software
|
||||
- [Tweaks Guide](/guides/tweaks/) — Understand system optimizations
|
||||
- [FAQ](/faq/) — Common questions and answers
|
||||
|
||||
## Getting help
|
||||
|
||||
If you need assistance:
|
||||
|
||||
- **Documentation**: Browse this documentation site
|
||||
- **Known Issues**: Check the [Known Issues](/known-issues/) page
|
||||
- **Discord**: Join the [community Discord server](https://discord.gg/RUbZUZyByQ)
|
||||
- **GitHub Issues**: Report bugs on [GitHub](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
- **YouTube**: Watch [video tutorials](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
|
||||
## Quick reference card
|
||||
|
||||
| Task | Location | Action |
|
||||
| ---- | -------- | ------ |
|
||||
| Install or upgrade apps | Install tab | Check boxes → Install/Upgrade Selected |
|
||||
| Uninstall apps | Install tab | Check boxes → Uninstall Selected |
|
||||
| Apply tweaks | Tweaks tab | Select tweaks → Run Tweaks |
|
||||
| Undo tweaks | Tweaks tab | Select tweaks → Undo Selected Tweaks |
|
||||
| Create restore point | Tweaks tab | Essential Tweaks section |
|
||||
| Fix network | Config tab | Fixes → Reset Network |
|
||||
| Change DNS | Tweaks tab | DNS section |
|
||||
| Open Control Panel | Config tab | Legacy Windows Panels |
|
||||
@@ -0,0 +1,155 @@
|
||||
---
|
||||
title: User Guide
|
||||
description: Overview of the WinUtil User Guide — installing apps, applying tweaks, running fixes, and managing updates.
|
||||
sidebar:
|
||||
order: 0
|
||||
---
|
||||
|
||||
Welcome to the official User Guide for **Winutil**, your all-in-one Windows toolkit.
|
||||
|
||||
:::caution
|
||||
Windows 10 is not supported by Winutil. Windows 10 reached the end of support on **October 14, 2025**.
|
||||
:::
|
||||
|
||||
## What is Winutil?
|
||||
|
||||
Winutil (Chris Titus Tech's Windows Utility) is a comprehensive PowerShell-based tool that helps you:
|
||||
|
||||
- **Install Applications**: Quickly install popular software without manual downloads
|
||||
- **Apply Tweaks**: Optimize Windows for performance, privacy, and usability
|
||||
- **Fix Issues**: Troubleshoot common Windows problems with one-click fixes
|
||||
- **Manage Updates**: Control how and when Windows updates install
|
||||
- **Access Tools**: Quick access to Windows panels and utilities
|
||||
|
||||
## Who Should Use Winutil?
|
||||
|
||||
Winutil is designed for:
|
||||
|
||||
- **Home Users**: People who want to optimize their personal PCs
|
||||
- **Power Users**: Users who want fine-grained control over Windows
|
||||
- **IT Professionals**: Teams managing multiple systems efficiently
|
||||
- **Gamers**: Users optimizing systems for gaming performance
|
||||
- **Privacy-Conscious Users**: People reducing telemetry and data collection
|
||||
- **Developers**: Users setting up clean development environments
|
||||
|
||||
## Getting Started
|
||||
|
||||
New to Winutil? Follow the guides below in order to get up and running quickly:
|
||||
|
||||
1. **[Getting Started](/guides/getting-started/)** - Learn how to launch Winutil and understand the basics.
|
||||
2. **[Applications](/guides/application/)** - Install, update, and remove apps with ease.
|
||||
3. **[Tweaks](/guides/tweaks/)** - Apply performance, privacy, and usability improvements.
|
||||
4. **[Features](/guides/features/)** - Explore built-in tools and common Windows fixes.
|
||||
5. **[Updates](/guides/updates/)** - Configure how Windows Update behaves on your system.
|
||||
6. **[Automation](/guides/automation/)** - Automate setups and reuse configurations across PCs.
|
||||
7. **[Win11 Creator](/guides/win11creator/)** - Build a custom debloated Windows 11 ISO.
|
||||
|
||||
## Main Features
|
||||
|
||||
### Application Installation
|
||||
|
||||
Browse and install hundreds of popular applications with a single click. No more hunting for download links or dealing with installer bloat.
|
||||
|
||||
**[Read the Applications Guide →](/guides/application/)**
|
||||
|
||||
### System Tweaks
|
||||
|
||||
Apply optimizations for performance, privacy, and usability. Choose from preset configurations or customize individual tweaks.
|
||||
|
||||
**[Read the Tweaks Guide →](/guides/tweaks/)**
|
||||
|
||||
### Config & Fixes
|
||||
|
||||
Quick fixes for common Windows problems:
|
||||
- Reset network settings
|
||||
- Fix Windows Update issues
|
||||
- Repair system files
|
||||
- Access legacy Windows panels
|
||||
|
||||
**[Read the Features Guide →](/guides/features/)**
|
||||
|
||||
### Update Management
|
||||
|
||||
Take control of Windows Updates with options to:
|
||||
- Enable/disable updates
|
||||
- Security updates only
|
||||
- Pause updates
|
||||
- Manage driver updates
|
||||
|
||||
**[Read the Updates Guide →](/guides/updates/)**
|
||||
|
||||
### Automation
|
||||
|
||||
Automate Winutil configurations for:
|
||||
- Multiple PC setups
|
||||
- Enterprise deployments
|
||||
- Consistent configurations
|
||||
- Scripted installations
|
||||
|
||||
**[Read the Automation Guide →](/guides/automation/)**
|
||||
|
||||
### Windows 11 Creator
|
||||
|
||||
Build a custom Windows 11 ISO with bloatware removed, telemetry disabled, and hardware requirement checks bypassed. You can then export it as an ISO file or write it directly to a USB drive.
|
||||
|
||||
**[Read the Win11 Creator Guide →](/guides/win11creator/)**
|
||||
|
||||
## Safety and Best Practices
|
||||
|
||||
Before using Winutil:
|
||||
|
||||
✅ **Always**:
|
||||
- Run PowerShell as Administrator
|
||||
- Create a system restore point before major changes
|
||||
- Understand what tweaks do before applying them
|
||||
- Start with Essential Tweaks before Advanced ones
|
||||
- Keep backups of important data
|
||||
|
||||
❌ **Never**:
|
||||
- Apply all tweaks without understanding them
|
||||
- Skip creating restore points
|
||||
- Use on production systems without testing
|
||||
- Disable security features unnecessarily
|
||||
|
||||
## System Requirements
|
||||
|
||||
- **Operating System**: Windows 11
|
||||
- **PowerShell**: Version 5.1 or later (included in Windows 11)
|
||||
- **Permissions**: Administrator access required
|
||||
- **Internet**: Required for downloading apps and updates
|
||||
- **.NET Framework**: 4.5+ (usually pre-installed)
|
||||
|
||||
## Getting Help
|
||||
|
||||
Need help?
|
||||
|
||||
- **Documentation**: You're reading it. Use the navigation menu.
|
||||
- **FAQ**: Check [Frequently Asked Questions](/faq/)
|
||||
- **Known Issues**: Review [Known Issues](/known-issues/)
|
||||
- **Discord**: Join the [community Discord](https://discord.gg/RUbZUZyByQ)
|
||||
- **GitHub**: Report bugs on [GitHub Issues](https://github.com/ChrisTitusTech/winutil/issues)
|
||||
- **YouTube**: Watch [video tutorials](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
|
||||
## Contributing
|
||||
|
||||
Want to help improve Winutil?
|
||||
|
||||
- **Report Bugs**: Submit issues on GitHub
|
||||
- **Suggest Features**: Open feature requests
|
||||
- **Contribute Code**: Submit pull requests
|
||||
- **Improve Docs**: Help expand this documentation
|
||||
- **Share Knowledge**: Help others in Discord
|
||||
|
||||
**[Read Contributing Guide →](/contributing/)**
|
||||
|
||||
## Video Tutorial
|
||||
|
||||
Watch the complete WinUtil overview: [https://www.youtube.com/watch?v=6UQZ5oQg8XA](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
|
||||
|
||||
Ready to get started? Head to the **[Getting Started Guide](/guides/getting-started/)**.
|
||||
|
||||
## Next
|
||||
|
||||
Dive right into the following section to get started:
|
||||
|
||||
**[Getting Started](/guides/getting-started/)** — Learn how to use WinUtil.
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Tweaks
|
||||
description: Apply recommended Windows changes, review optional presets, and adjust supporting settings such as DNS and power plans.
|
||||
sidebar:
|
||||
order: 3
|
||||
---
|
||||
|
||||
|
||||
|
||||
Use the Tweaks tab to apply recommended Windows changes, review optional presets, and adjust a few supporting settings such as DNS and power plans. Start with a preset unless you already know which individual tweaks you want.
|
||||
|
||||
### Recommended Selections
|
||||
Use the quick-selection buttons at the top of the Tweaks tab to speed up setup:
|
||||
|
||||
* **Standard**: Selects the recommended baseline set of tweaks for most users.
|
||||
* **Minimal**: Selects a smaller, lower-impact set of common tweaks.
|
||||
* **Advanced**: Selects a focused set of safer advanced tweaks. This preset intentionally skips restore point creation and cleanup tasks to avoid a long runtime.
|
||||
* **Clear**: Clears all currently selected tweaks.
|
||||
* **Get Installed Tweaks**: Best-effort detection for tweaks already applied to your system.
|
||||
|
||||
### Run Tweaks
|
||||
* **Open the Tweaks tab**: Navigate to the **Tweaks** tab in the application.
|
||||
* **Select Tweaks**: Choose the tweaks you want to apply. You can use the presets available at the top for convenience.
|
||||
* **Run Tweaks**: After selecting the desired tweaks, click **Run Tweaks** at the bottom of the screen.
|
||||
|
||||
:::note
|
||||
To see what each preset includes, view [preset.json](https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json).
|
||||
:::
|
||||
|
||||
:::caution
|
||||
Some tweaks take effect immediately, while others may require Explorer to restart, a sign-out, or a full reboot.
|
||||
:::
|
||||
|
||||
### Undo Tweaks
|
||||
* **Open the Tweaks tab**: Go to the **Tweaks** tab located next to **Install**.
|
||||
* **Select Tweaks to Remove**: Choose the tweaks you want to disable or remove.
|
||||
* **Undo Tweaks**: Click **Undo Selected Tweaks** at the bottom of the screen to apply the changes.
|
||||
|
||||
### AppX Packages
|
||||
|
||||
Open **AppX Removal** from the Tweaks tab to manage the listed Windows apps. Select one or more packages, then choose **Install Selected** or **Remove Selected**.
|
||||
|
||||
When installing a selected package, WinUtil first registers an existing local `AppxManifest.xml`. If no usable local manifest remains, WinUtil installs the package from the Microsoft Store through WinGet when a Store product ID is available.
|
||||
|
||||
During AppX installation or removal, the window-level progress bar shows the current package, completed package count, and overall progress. The Windows taskbar also reflects progress and the final success or failure state.
|
||||
|
||||
### Essential Tweaks
|
||||
Essential Tweaks are the safest starting point for most systems. They focus on lower-risk changes that improve usability, reduce noise, and avoid the more invasive changes found in advanced options.
|
||||
|
||||
### Advanced Tweaks (CAUTION)
|
||||
Advanced Tweaks are for users who understand the side effects of deeper Windows changes. Create a restore point first, review each item, and avoid treating the full advanced list as a one-click baseline.
|
||||
|
||||
### O&O ShutUp10++
|
||||
[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from WinUtil with one click. It is a free privacy tool for Windows that helps users manage telemetry, update behavior, and app permission settings.
|
||||
|
||||
Watch a walkthrough: [https://www.youtube.com/watch?v=3HvNr8eMcv0](https://www.youtube.com/watch?v=3HvNr8eMcv0)
|
||||
|
||||
### DNS
|
||||
|
||||
Use the DNS section to switch both IPv4 and IPv6 DNS providers without editing adapter settings manually. Choose the option that best matches your priority: speed, filtering, or privacy.
|
||||
|
||||
* **Default**: Uses the default DNS settings configured by your ISP or network.
|
||||
* **DHCP**: Automatically acquires DNS settings from the DHCP server.
|
||||
* [**Google**](https://developers.google.com/speed/public-dns?hl=en): A reliable and fast DNS service provided by Google.
|
||||
* [**Cloudflare**](https://developers.cloudflare.com/1.1.1.1/): Known for speed and privacy, Cloudflare DNS is a popular choice for enhancing internet performance.
|
||||
* [**Cloudflare_Malware**](https://developers.cloudflare.com/1.1.1.1/setup/#:~:text=Use%20the%20following%20DNS%20resolvers%20to%20block%20malicious%20content%3A): Provides additional protection by blocking malware sites.
|
||||
* [**Cloudflare_Malware_Adult**](https://developers.cloudflare.com/1.1.1.1/setup/#:~:text=Use%20the%20following%20DNS%20resolvers%20to%20block%20malware%20and%20adult%20content%3A): Blocks both malware and adult content, offering more comprehensive filtering.
|
||||
* [**Open_DNS**](https://www.opendns.com/setupguide/#familyshield): Offers customizable filtering and enhanced security features.
|
||||
* [**Quad9**](https://quad9.net/): Focuses on security by blocking known malicious domains.
|
||||
* [**AdGuard_Ads_Trackers**](https://adguard-dns.io/en/welcome.html): AdGuard DNS blocks ads, trackers, and other unwanted DNS requests. Visit the website and sign in for a dashboard, statistics, and additional server-side customization.
|
||||
* [**AdGuard_Ads_Trackers_Malware_Adult**](https://adguard-dns.io/en/welcome.html): AdGuard DNS blocks ads, trackers, malware, and adult content, and enables Safe Search and Safe Mode where possible.
|
||||
|
||||
### Customize Preferences
|
||||
|
||||
Use Customize Preferences for smaller visual and behavior changes that do not fit the main tweak presets.
|
||||
|
||||
### Performance Plans
|
||||
|
||||
Use Performance Plans to enable or remove the Ultimate Performance power profile.
|
||||
|
||||
#### Add and activate the Ultimate Performance Profile:
|
||||
* Enables and activates the Ultimate Performance Profile to enhance system performance by minimizing latency and increasing efficiency.
|
||||
#### Remove Ultimate Performance Profile:
|
||||
* Deactivates the Ultimate Performance Profile, changing the system to the Balanced Profile.
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Updates
|
||||
description: Choose how aggressively Windows Update is managed on your system with WinUtil's three update modes.
|
||||
sidebar:
|
||||
order: 5
|
||||
---
|
||||
|
||||
WinUtil provides three update modes so you can choose how aggressively Windows Update is managed on your system:
|
||||
|
||||
Changing modes adjusts system-wide Windows Update behavior. After switching modes, give Windows a moment to apply the policy and plan for a restart if the new state does not appear immediately.
|
||||
|
||||
- **Recommended**: Prioritizes stability while still receiving security updates
|
||||
- **Windows Default**: Restores standard Windows Update behavior
|
||||
- **Disable Updates**: Blocks Windows Update and should only be used with extreme caution
|
||||
|
||||
### Windows Default
|
||||
|
||||
- **What it does**: Removes Windows Update policies managed by WinUtil, restores update service startup settings, and re-enables update scheduled tasks.
|
||||
- **Best for**: Systems where you want Windows to manage updates normally.
|
||||
- **Notes**: Only values managed by WinUtil are removed; other Windows Update policies are left in place. If update errors continue, use the reset option in the **Config** tab to repair Microsoft Update components.
|
||||
|
||||
### Recommended
|
||||
|
||||
- **What it does**: Applies a more conservative update strategy designed for most users.
|
||||
- **Feature updates**: Delayed by **365 days** to reduce the chance of disruption from major Windows changes.
|
||||
- **Quality updates**: Delayed by **4 days** to allow time for early issues to surface while still keeping the system protected.
|
||||
- **Drivers**: Excluded from Windows quality updates.
|
||||
- **Restarts**: Scheduled updates do not automatically restart Windows while a user is signed in. A restart explicitly scheduled by a user still takes precedence.
|
||||
- **Availability**: Update deferral policies apply to Windows Pro, Enterprise, and Education editions.
|
||||
- **Why use it**: This mode offers the best balance between security and stability, which is why it is the recommended option for most PCs.
|
||||
|
||||
### Disable Updates (NOT RECOMMENDED!)
|
||||
|
||||
- **What it does**: Disables automatic update policy, stops and disables update services, disables update scheduled tasks, and clears downloaded update files.
|
||||
- **Best for**: Highly controlled or special-purpose systems where updates must remain off temporarily.
|
||||
- **Warning**: This leaves the system without security patches and significantly increases security risk.
|
||||
- **Notes**: Windows servicing can restore update components in some circumstances. Use **Restore Defaults** when you are ready to receive updates again.
|
||||
- **Recommendation**: Avoid this mode unless you fully understand the tradeoffs and have a specific reason to use it.
|
||||
@@ -0,0 +1,154 @@
|
||||
---
|
||||
title: Win11 Creator
|
||||
description: Build a custom, debloated Windows 11 ISO from an official Microsoft image using WinUtil's Win11 Creator tool.
|
||||
sidebar:
|
||||
order: 7
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components';
|
||||
|
||||
## Using WinUtil's Win11 Creator
|
||||
|
||||
WinUtil includes a built-in **Win11 Creator** tool that lets you take an official Windows 11 ISO and produce a customized, debloated version. The resulting image can remove telemetry, bypass hardware requirement checks, and enable local account setup out of the box. You can export the result as a new ISO file or write it directly to a USB drive.
|
||||
|
||||
|
||||
|
||||
:::caution
|
||||
You need an **official Windows 11 ISO** from [Microsoft's website](https://www.microsoft.com/en-us/software-download/windows11) before starting. Custom, modified, or non-official ISOs are not supported. The process uses ~10–15 GB of temporary disk space, so make sure you have room.
|
||||
:::
|
||||
|
||||
:::note
|
||||
This workflow is intended for fresh Windows installs, not in-place upgrades of an existing installation.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
### Step 1 — Select Your Official Windows 11 ISO
|
||||
|
||||
1. Open WinUtil and go to the **Win11 Creator** tab.
|
||||
2. Click **Browse** and select your **official Windows 11 ISO file** from Microsoft (must be 4 GB or larger). Custom or modified ISOs are not supported.
|
||||
3. The file path and size will appear on screen once selected.
|
||||
|
||||
---
|
||||
|
||||
### Step 2 — Mount & Verify
|
||||
|
||||
1. Click **Mount & Verify ISO**.
|
||||
2. WinUtil mounts the ISO, checks for a valid `install.wim` or `install.esd`, and reads the available editions (Home, Pro, Enterprise, etc.).
|
||||
3. Once verified, select your desired **edition** from the dropdown — Pro is selected by default if available.
|
||||
|
||||
:::note
|
||||
This step takes around 10–30 seconds, depending on your drive speed.
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
### Step 3 — Run the Modification
|
||||
|
||||
Click **Run Windows ISO Modification and Creator** to start the customization process. WinUtil will:
|
||||
|
||||
**App & Component Removal:**
|
||||
- **Remove 40+ bloat apps** — Clipchamp, Teams, Copilot, Dev Home, new Outlook, Bing apps, Solitaire, and more
|
||||
- **Delete OneDrive setup** from the image
|
||||
|
||||
**System Customization:**
|
||||
- **Bypass hardware checks** — removes TPM, Secure Boot, CPU, RAM, and storage requirement enforcement so the ISO installs on unsupported hardware
|
||||
- **Enable local account setup** — injects an `autounattend.xml` that skips the Microsoft account screen during OOBE
|
||||
- **Disable BitLocker and device encryption** — removes startup overhead
|
||||
- **Disable Chat icon** — removes chat taskbar button
|
||||
- **Strip unused editions** — keeps only your selected edition, saving 1–2 GB per removed edition
|
||||
- **Pin the selected edition during setup** — writes setup metadata so OEM firmware keys for a different edition do not force the installer down the wrong product-key path
|
||||
- **Clean the component store** — runs DISM cleanup to reclaim another 300–800 MB
|
||||
|
||||
**Privacy & Telemetry Tweaks:**
|
||||
- **Disable telemetry** — advertising ID, tailored experiences, input personalization, speech online privacy
|
||||
- **Disable cloud content features** — app suggestions, Microsoft Store recommendations
|
||||
- **Remove telemetry scheduled tasks** — CEIP, Appraiser, WaaSMedic, and others
|
||||
- **Disable OneDrive folder backup** — prevents automatic backups to cloud
|
||||
- **Prevent DevHome and Outlook post-setup installation**
|
||||
- **Prevent Teams installation** — blocks auto-install after OOBE
|
||||
- **Prevent new Outlook Mail app installation**
|
||||
- **Disable Windows Update during OOBE** — re-enabled automatically on first login
|
||||
- **Disable Copilot and search box suggestions**
|
||||
|
||||
**Optional: Driver Injection**
|
||||
- If enabled, it injects all drivers from your current system into the install.wim and boot.wim — useful for offline installations on machines with missing drivers. This is an optional checkbox in Step 3.
|
||||
|
||||
A live log shows progress as each step completes. This stage usually takes **10–30 minutes** depending on disk speed. The WIM dismount near the end is the slowest part, so do not close WinUtil while it is running.
|
||||
|
||||
---
|
||||
|
||||
### Step 4 — Export Your Result
|
||||
|
||||
Once the modification is complete, choose how to save your image:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Save as ISO">
|
||||
1. Click **Save as an ISO File**.
|
||||
2. Choose a save location (defaults to your Desktop as `Win11_Modified_yyyyMMdd.iso`).
|
||||
3. WinUtil builds a dual BIOS/UEFI bootable ISO using `oscdimg.exe`.
|
||||
|
||||
:::note
|
||||
`oscdimg.exe` (part of the Windows ADK) is required. If it's not found, WinUtil will attempt to install it automatically via WinGet. If that fails, install it manually: `winget install -e --id Microsoft.OSCDIMG`
|
||||
:::
|
||||
</TabItem>
|
||||
<TabItem label="Write to USB">
|
||||
1. Click **Write Directly to a USB Drive**.
|
||||
2. Select your USB drive from the dropdown (click **Refresh** if it doesn't appear).
|
||||
3. Click **Erase & Write to USB** and confirm the warning — **all data on the drive will be permanently erased**.
|
||||
4. WinUtil formats the drive as GPT with a 512 MB EFI partition and copies the modified Windows files.
|
||||
|
||||
:::danger
|
||||
Double-check you have selected the correct drive before confirming. This operation cannot be undone.
|
||||
:::
|
||||
|
||||
**Minimum USB size:** 8 GB recommended. Writing takes 10–20 minutes.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
---
|
||||
|
||||
### Step 5 — Clean Up (Optional)
|
||||
|
||||
Click **Clean & Reset** to delete the temporary working directory (~10–15 GB) and return the tool to its initial state, ready for a new ISO. You will be asked to confirm before anything is deleted.
|
||||
|
||||
---
|
||||
|
||||
### What the Modified ISO Does Differently
|
||||
|
||||
When you install Windows 11 from your modified ISO:
|
||||
|
||||
- **No Microsoft account required** — create a local account directly during setup
|
||||
- **No hardware checks** — installs on machines without TPM 2.0, Secure Boot, or supported CPUs
|
||||
- **Dark mode enabled by default**
|
||||
- **Empty taskbar and Start Menu** — no pinned apps, Chat icon removed
|
||||
- **Windows Update disabled during OOBE** — automatically re-enabled on first login to prevent setup interruptions
|
||||
- **BitLocker disabled** — removes startup overhead on first boot
|
||||
|
||||
---
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
| Problem | Fix |
|
||||
|---------|-----|
|
||||
| "install.wim not found" | Not a valid Windows 11 ISO — download a fresh one from Microsoft |
|
||||
| "oscdimg.exe not found" | Run `winget install -e --id Microsoft.OSCDIMG` then retry |
|
||||
| USB drive not showing up | Plug it in, wait a few seconds, then click **Refresh** |
|
||||
| Modification seems stuck | The WIM dismount step is slow — wait at least 10 minutes before assuming it's frozen |
|
||||
| "Access Denied" error | Make sure WinUtil is running as Administrator |
|
||||
| "Setup has failed to validate the product key" | Recreate the ISO with the latest WinUtil. The creator now removes stale `PID.txt`, writes `sources\ei.cfg`, and pins the selected image in `autounattend.xml` so setup does not use an embedded OEM key for a different edition |
|
||||
|
||||
---
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- Download official Windows 11 media from [Microsoft](https://www.microsoft.com/en-us/software-download/windows11).
|
||||
- If you prefer to write a finished ISO with another tool, common choices include [Rufus](https://rufus.ie/) or [Ventoy](https://www.ventoy.net/).
|
||||
|
||||
:::note
|
||||
Always download Windows ISOs from official Microsoft sources or trusted tools like Rufus/UUP Dump to avoid tampered images.
|
||||
:::
|
||||
|
||||
:::note
|
||||
Newer Windows 11 ISOs may not boot correctly on older versions of Ventoy — make sure Ventoy is up to date before use. If issues persist after updating, this is a Ventoy compatibility limitation outside of WinUtil's control.
|
||||
:::
|
||||
@@ -0,0 +1,199 @@
|
||||
---
|
||||
title: Documentation
|
||||
description: Chris Titus Tech's Windows Utility — install apps, apply tweaks, run fixes, and manage Windows from one place.
|
||||
template: splash
|
||||
editUrl: false
|
||||
heroEyebrow: Open Source Windows Setup Utility
|
||||
heroCaption: Free. Open source. No installer, no telemetry, no bloat.
|
||||
heroBadges:
|
||||
- src: https://img.shields.io/github/v/release/ChrisTitusTech/winutil?color=%230567ff&label=Latest%20Release&style=for-the-badge
|
||||
alt: Latest release
|
||||
href: https://github.com/ChrisTitusTech/winutil/releases/latest
|
||||
- src: https://img.shields.io/github/downloads/ChrisTitusTech/winutil/winutil.ps1?label=Total%20Downloads&style=for-the-badge
|
||||
alt: Total downloads
|
||||
- src: https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ
|
||||
alt: Discord community server
|
||||
href: https://discord.gg/RUbZUZyByQ
|
||||
hero:
|
||||
title: Set up Windows the way you actually want it
|
||||
tagline: Install apps, apply tweaks, run fixes, and manage Windows updates — all from one script, one window, no fuss.
|
||||
image:
|
||||
file: ../../assets/branding/title-screen.png
|
||||
actions:
|
||||
- text: Get Started
|
||||
link: /guides/getting-started/
|
||||
icon: right-arrow
|
||||
- text: View on GitHub
|
||||
link: https://github.com/ChrisTitusTech/winutil
|
||||
icon: external
|
||||
variant: secondary
|
||||
---
|
||||
|
||||
import { Icon, Code } from '@astrojs/starlight/components';
|
||||
import CornerCard from '../../components/CornerCard.astro';
|
||||
|
||||
{/* Trust bar: icon + label chips under the hero. */}
|
||||
<section class="wu-section wu-section--trust">
|
||||
<div class="wu-trust-bar">
|
||||
<span class="wu-trust-item"><Icon name="github" /> Open source</span>
|
||||
<span class="wu-trust-item"><Icon name="download" /> No installer</span>
|
||||
<span class="wu-trust-item"><Icon name="padlock" /> No telemetry added</span>
|
||||
<span class="wu-trust-item"><Icon name="approve-check-circle" /> Everything reversible</span>
|
||||
<span class="wu-trust-item"><Icon name="desktop" /> Windows 11 ready</span>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Problem section: pain points WinUtil solves. */}
|
||||
<section class="wu-section wu-section--tint">
|
||||
<div class="wu-section-inner wu-text-narrow">
|
||||
<div class="wu-section-head wu-align-left">
|
||||
<h2>Windows setup is easy to start and tedious to finish</h2>
|
||||
<p>A fresh install works fine out of the box. Getting it configured the way you actually want takes an afternoon of registry edits, forum posts, and forgotten steps.</p>
|
||||
</div>
|
||||
<ul class="wu-problem-list">
|
||||
<li><span class="wu-bullet"><Icon name="warning" /></span> Essential apps mean a dozen separate installers, each with its own bundled toolbar to decline.</li>
|
||||
<li><span class="wu-bullet"><Icon name="warning" /></span> Privacy and telemetry settings are scattered across half a dozen different settings panels.</li>
|
||||
<li><span class="wu-bullet"><Icon name="warning" /></span> The tweaks worth applying live in year-old forum threads, mixed in with outdated or risky advice.</li>
|
||||
<li><span class="wu-bullet"><Icon name="warning" /></span> Undoing a tweak means remembering exactly what you changed and how.</li>
|
||||
<li><span class="wu-bullet"><Icon name="warning" /></span> Doing it all again on the next machine means starting from zero.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Solution grid: how WinUtil addresses each problem above. */}
|
||||
<section class="wu-section">
|
||||
<div class="wu-section-inner">
|
||||
<div class="wu-section-head">
|
||||
<h2>WinUtil puts a real control panel on top of Windows</h2>
|
||||
<p>Instead of stitching together installers, registry hacks, and forum wisdom, you manage the whole setup from one window.</p>
|
||||
</div>
|
||||
<div class="wu-solution-grid">
|
||||
<div class="wu-solution">
|
||||
<div class="wu-solution-icon"><Icon name="download" /></div>
|
||||
<h3>Install without the bloat</h3>
|
||||
<p>WinGet and Chocolatey install clean builds of your everyday apps, with no bundled toolbars or bundled offers.</p>
|
||||
</div>
|
||||
<div class="wu-solution">
|
||||
<div class="wu-solution-icon"><Icon name="setting" /></div>
|
||||
<h3>Tweak with a checkbox</h3>
|
||||
<p>Essential and advanced tweaks for privacy, performance, and UI behavior are one click away, grouped by what they actually do.</p>
|
||||
</div>
|
||||
<div class="wu-solution">
|
||||
<div class="wu-solution-icon"><Icon name="approve-check-circle" /></div>
|
||||
<h3>Undo what you don't like</h3>
|
||||
<p>Nearly every tweak can be reverted from the same panel, so trying something risky doesn't mean a full reinstall.</p>
|
||||
</div>
|
||||
<div class="wu-solution">
|
||||
<div class="wu-solution-icon"><Icon name="server" /></div>
|
||||
<h3>Fix what's broken</h3>
|
||||
<p>One-click repairs for networking, Windows Update, and WinGet handle the fixes people usually paste from a forum thread.</p>
|
||||
</div>
|
||||
<div class="wu-solution">
|
||||
<div class="wu-solution-icon"><Icon name="cloud-download" /></div>
|
||||
<h3>Manage updates your way</h3>
|
||||
<p>Switch between full updates, security-only updates, or fully paused — and back again — without digging through Group Policy.</p>
|
||||
</div>
|
||||
<div class="wu-solution">
|
||||
<div class="wu-solution-icon"><Icon name="desktop" /></div>
|
||||
<h3>Build your own ISO</h3>
|
||||
<p>Win11 Creator debloats and preconfigures an official Microsoft image, so new installs start from your baseline.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Feature grid: CornerCard highlights. */}
|
||||
<section class="wu-section wu-section--tint">
|
||||
<div class="wu-section-inner">
|
||||
<div class="wu-section-head">
|
||||
<h2>Everything you need to set up a machine, once</h2>
|
||||
</div>
|
||||
<div class="wu-feature-grid">
|
||||
<CornerCard icon="padlock" title="Nothing phones home">
|
||||
WinUtil doesn't collect or transmit anything. It's a script that runs, makes the changes you selected, and exits.
|
||||
</CornerCard>
|
||||
<CornerCard icon="approve-check-circle" title="Reversible by default">
|
||||
Tweaks are applied through documented, undoable actions instead of one-way registry edits.
|
||||
</CornerCard>
|
||||
<CornerCard icon="setting" title="Grouped presets">
|
||||
Minimal, Standard, and Advanced presets give you a sane starting point instead of picking through every tweak individually.
|
||||
</CornerCard>
|
||||
<CornerCard icon="cloud-download" title="WinGet & Chocolatey">
|
||||
Application installs go through package managers you can audit, not opaque bundled installers.
|
||||
</CornerCard>
|
||||
<CornerCard icon="server" title="Automation-friendly">
|
||||
Drive WinUtil unattended with config files and parameters for repeatable rollouts across machines.
|
||||
</CornerCard>
|
||||
<CornerCard icon="desktop" title="Custom Win11 ISOs">
|
||||
Debloat and preconfigure a Windows 11 image before it's ever installed.
|
||||
</CornerCard>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Step timeline: quick-start walkthrough + secondary CTA. */}
|
||||
<section class="wu-section">
|
||||
<div class="wu-section-inner">
|
||||
<div class="wu-section-head">
|
||||
<h2>From a blank terminal to a configured PC</h2>
|
||||
</div>
|
||||
<div class="wu-timeline">
|
||||
<div class="wu-timeline-step">
|
||||
<span class="wu-timeline-number">1</span>
|
||||
<h3>Open PowerShell as Administrator</h3>
|
||||
<p>Right-click the Start button and choose Terminal (Admin), or launch PowerShell and elevate manually.</p>
|
||||
</div>
|
||||
<div class="wu-timeline-step">
|
||||
<span class="wu-timeline-number">2</span>
|
||||
<h3>Run the launch command</h3>
|
||||
<p>Downloads and starts the latest release.</p>
|
||||
<Code code={'irm "https://christitus.com/win" | iex'} lang="powershell" />
|
||||
</div>
|
||||
<div class="wu-timeline-step">
|
||||
<span class="wu-timeline-number">3</span>
|
||||
<h3>Install, tweak, fix, update</h3>
|
||||
<p>Work through the Install, Tweaks, Config, and Updates tabs — everything is undoable.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="wu-cta" style="margin-top: 3rem;">
|
||||
<a class="wu-btn wu-btn-secondary" href="/guides/getting-started/">
|
||||
Read the Docs
|
||||
<Icon name="right-arrow" />
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Benefit checklist. */}
|
||||
<section class="wu-section wu-section--tint">
|
||||
<div class="wu-section-inner wu-text-narrow">
|
||||
<div class="wu-section-head wu-align-left">
|
||||
<h2>Built for the gap between a fresh install and a finished machine</h2>
|
||||
<p>Registry edits and PowerShell one-liners work. WinUtil makes them repeatable.</p>
|
||||
</div>
|
||||
<ul class="wu-benefit-list">
|
||||
<li><span class="wu-check"><Icon name="approve-check" /></span> You keep full control — every tweak is visible, documented, and reversible.</li>
|
||||
<li><span class="wu-check"><Icon name="approve-check" /></span> You gain a single interface for installs, tweaks, fixes, and updates instead of five different tools.</li>
|
||||
<li><span class="wu-check"><Icon name="approve-check" /></span> You avoid the bundled toolbars and bloat that come with most software installers.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{/* Final CTA. */}
|
||||
<section class="wu-section">
|
||||
<div class="wu-section-inner wu-text-narrow wu-cta">
|
||||
<h2>Stop hunting for the same fixes every time</h2>
|
||||
<p>Get a script that installs, tweaks, fixes, and updates Windows from one window.</p>
|
||||
<div class="wu-btn-row">
|
||||
<a class="wu-btn wu-btn-primary" href="/guides/getting-started/">
|
||||
{'Get Started'}
|
||||
<Icon name="right-arrow" size="1.5em" class="wu-icon-arrow" />
|
||||
</a>
|
||||
<a class="wu-btn wu-btn-secondary" href="https://github.com/ChrisTitusTech/winutil">
|
||||
<Icon name="github" />
|
||||
{' View on GitHub'}
|
||||
</a>
|
||||
</div>
|
||||
<p class="wu-cta-footnote">Free and open source. No installer, no telemetry, no account required.</p>
|
||||
</div>
|
||||
</section>
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Known Issues
|
||||
description: Known problems with WinUtil and how to work around them.
|
||||
---
|
||||
|
||||
### Download not working
|
||||
|
||||
If you run WinUtil and get an error like:
|
||||
|
||||
`< : The term '<' is not recognized as the name of a cmdlet, function, script file, or operable program.`
|
||||
|
||||
try using a **VPN** and if that doesn't work than report the issue to https://github.com/ChrisTitusTech/winutil/issues
|
||||
|
||||
### Script Won't Run
|
||||
|
||||
If you run WinUtil and get the error:
|
||||
|
||||
`"WinUtil is unable to run on your system. PowerShell execution is restricted by security policies"`
|
||||
|
||||
this means that your PowerShell session is in **Constrained Language Mode**, which prevents WinUtil from running.
|
||||
|
||||
### Ultimate Performance Plan Not Working
|
||||
|
||||
The Ultimate Performance power plan may not work on some laptops that do not fully support this power plan.
|
||||
|
||||
In these cases, the power plan may fail to apply, This is expected behavior on unsupported hardware.
|
||||
|
||||
### Revert start menu tweak not working
|
||||
|
||||
Revert start menu tweak stops working starting with **Windows 11 update KB5089573** (released in May 2026).
|
||||
|
||||
In this update, Microsoft completely removed the old Start Menu code from Windows, so we aren't able to bring it back.
|
||||
|
||||
### Issues with PowerShell 7 or Class not registered Error
|
||||
Installing PowerShell 7 from the Microsoft Store (MSIX package) is known to cause issues with DISM cmdlets such as `Get-WindowsOptionalFeature` and `Enable-WindowsOptionalFeature`, resulting in a `Class not registered` COM error.
|
||||
|
||||
This might also make it so running the "pre-installed app removal" will take a indefinite amount of time
|
||||
|
||||
Instead, install PowerShell 7 using one of the following methods:
|
||||
|
||||
**winget (recommended):**
|
||||
```powershell
|
||||
winget install --id Microsoft.PowerShell --source winget --installer-type wix
|
||||
```
|
||||
**Direct MSI from GitHub Releases:** Download the `.msi` installer from the [PowerShell GitHub Releases](https://github.com/PowerShell/PowerShell/releases) page.
|
||||
|
||||
For more details see https://github.com/PowerShell/PowerShell/issues/13866
|
||||
@@ -0,0 +1,6 @@
|
||||
/* Self-hosted fonts: Geist for UI text, JetBrains Mono for code. Avoids external requests at runtime. */
|
||||
@import '@fontsource/geist-sans/400.css';
|
||||
@import '@fontsource/geist-sans/500.css';
|
||||
@import '@fontsource/geist-sans/600.css';
|
||||
@import '@fontsource/geist-sans/700.css';
|
||||
@import '@fontsource-variable/jetbrains-mono';
|
||||
@@ -0,0 +1,476 @@
|
||||
/* WinUtil docs theme: grayscale palette with WinUtil blue (#0567ff) as the single accent, dark by default. */
|
||||
@import './fonts.css';
|
||||
|
||||
:root {
|
||||
--sl-font: 'Geist', var(--sl-font-system);
|
||||
--sl-font-mono: 'JetBrains Mono Variable', var(--sl-font-system-mono);
|
||||
|
||||
/* WinUtil brand blue, matching the app logo (#0567ff). */
|
||||
--wu-accent-h: 216;
|
||||
--wu-accent: hsl(var(--wu-accent-h) 100% 51%);
|
||||
--wu-accent-dim: hsl(var(--wu-accent-h) 90% 45%);
|
||||
|
||||
--wu-radius-sm: 0.5rem;
|
||||
--wu-radius: 0.625rem;
|
||||
--wu-radius-lg: 1rem;
|
||||
}
|
||||
|
||||
/* Dark mode (default). */
|
||||
:root,
|
||||
::backdrop {
|
||||
--sl-color-accent-low: hsl(var(--wu-accent-h) 60% 18%);
|
||||
--sl-color-accent: var(--wu-accent);
|
||||
--sl-color-accent-high: hsl(var(--wu-accent-h) 100% 85%);
|
||||
|
||||
--sl-color-white: #fafafa;
|
||||
--sl-color-gray-1: #ededed;
|
||||
--sl-color-gray-2: #b8b8b8;
|
||||
--sl-color-gray-3: #8c8c8c;
|
||||
--sl-color-gray-4: #4a4a4a;
|
||||
--sl-color-gray-5: #2a2a2a;
|
||||
--sl-color-gray-6: #171717;
|
||||
--sl-color-black: #0a0a0a;
|
||||
|
||||
--sl-color-bg: #0a0a0a;
|
||||
--sl-color-bg-nav: #0d0d0d;
|
||||
--sl-color-bg-sidebar: #0d0d0d;
|
||||
--sl-color-bg-inline-code: #1b1b1b;
|
||||
--sl-color-hairline-light: #2a2a2a;
|
||||
--sl-color-hairline: #1e1e1e;
|
||||
--sl-color-hairline-shade: #000;
|
||||
}
|
||||
|
||||
/* Light mode. */
|
||||
:root[data-theme='light'],
|
||||
[data-theme='light'] ::backdrop {
|
||||
--sl-color-accent-low: hsl(var(--wu-accent-h) 90% 92%);
|
||||
--sl-color-accent: var(--wu-accent-dim);
|
||||
--sl-color-accent-high: hsl(var(--wu-accent-h) 80% 34%);
|
||||
|
||||
--sl-color-white: #0a0a0a;
|
||||
--sl-color-gray-1: #171717;
|
||||
--sl-color-gray-2: #333333;
|
||||
--sl-color-gray-3: #737373;
|
||||
--sl-color-gray-4: #a3a3a3;
|
||||
--sl-color-gray-5: #d9d9d9;
|
||||
--sl-color-gray-6: #f1f1f1;
|
||||
--sl-color-gray-7: #fafafa;
|
||||
--sl-color-black: #ffffff;
|
||||
|
||||
--sl-color-bg: #ffffff;
|
||||
--sl-color-bg-nav: #fafafa;
|
||||
--sl-color-bg-inline-code: #f1f1f1;
|
||||
--sl-color-hairline-light: #ececec;
|
||||
--sl-color-hairline-shade: #ececec;
|
||||
}
|
||||
|
||||
/* Heading weight/tracking. */
|
||||
.sl-markdown-content :is(h1, h2, h3, h4, h5, h6) {
|
||||
font-weight: 600;
|
||||
letter-spacing: -0.01em;
|
||||
}
|
||||
|
||||
/* Rounded code blocks/inline code. */
|
||||
.sl-markdown-content code:not(:where(.not-content *)) {
|
||||
border-radius: var(--wu-radius-sm);
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
}
|
||||
.sl-markdown-content pre:not(:where(.not-content *)) {
|
||||
border-radius: var(--wu-radius);
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
}
|
||||
.starlight-aside {
|
||||
border-radius: 0 var(--wu-radius-sm) var(--wu-radius-sm) 0;
|
||||
}
|
||||
|
||||
/* Windows-style minimize/maximize/close glyph for the code blocks */
|
||||
.expressive-code .frame.is-terminal .header::before {
|
||||
left: auto !important;
|
||||
right: 0.85rem !important;
|
||||
width: 4.75rem !important;
|
||||
height: 0.7rem !important;
|
||||
opacity: 0.85 !important;
|
||||
--ec-frm-trmIcon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 96 16' fill='none' stroke='black' stroke-width='1.6' stroke-linecap='round'%3E%3Cpath d='M4 8h12'/%3E%3Crect x='42' y='3.5' width='12' height='9' rx='0.5'/%3E%3Cpath d='M80 3l12 10M92 3L80 13'/%3E%3C/svg%3E");
|
||||
}
|
||||
|
||||
/* Cards (CardGrid / LinkCard): rounded, accent border on hover. */
|
||||
.sl-markdown-content .card,
|
||||
a.link-card {
|
||||
border-radius: var(--wu-radius) !important;
|
||||
transition:
|
||||
border-color 0.15s ease,
|
||||
transform 0.15s ease;
|
||||
}
|
||||
.sl-markdown-content .card:hover,
|
||||
a.link-card:hover {
|
||||
border-color: var(--sl-color-accent);
|
||||
}
|
||||
|
||||
/* Sidebar + nav background/border. */
|
||||
.sidebar-pane,
|
||||
header.header {
|
||||
background-color: var(--sl-color-bg-nav);
|
||||
border-color: var(--sl-color-hairline-light);
|
||||
}
|
||||
|
||||
/* Prevents a horizontal scrollbar from the hero's full-bleed 100vw background trick. */
|
||||
body {
|
||||
overflow-x: hidden;
|
||||
}
|
||||
|
||||
/* ============================================================
|
||||
Landing page marketing sections.
|
||||
============================================================ */
|
||||
|
||||
/* Shared buttons (hero actions + mid-page + final CTA). */
|
||||
.wu-btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
gap: 0.5em;
|
||||
height: 2.5rem;
|
||||
padding-inline: 1.5rem;
|
||||
border-radius: var(--wu-radius-sm);
|
||||
font-size: var(--sl-text-sm);
|
||||
font-weight: 500;
|
||||
line-height: 1;
|
||||
text-decoration: none;
|
||||
transition:
|
||||
filter 0.15s ease,
|
||||
border-color 0.15s ease,
|
||||
color 0.15s ease;
|
||||
}
|
||||
/* The right/left-arrow glyph's visual weight sits high in its viewBox, so it
|
||||
reads as floating above the label's baseline without this nudge. */
|
||||
.wu-btn .wu-icon-arrow {
|
||||
position: relative;
|
||||
top: 0.05em;
|
||||
}
|
||||
.wu-btn-primary {
|
||||
background: var(--wu-accent);
|
||||
color: #fff;
|
||||
}
|
||||
.wu-btn-primary:hover {
|
||||
filter: brightness(1.1);
|
||||
}
|
||||
.wu-btn-secondary {
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
color: var(--sl-color-white);
|
||||
background: transparent;
|
||||
}
|
||||
.wu-btn-secondary:hover {
|
||||
border-color: var(--sl-color-accent);
|
||||
color: var(--sl-color-accent);
|
||||
}
|
||||
/* Neutralizes any stray <p> MDX wraps around icon+text content, so it never breaks the flex row. */
|
||||
.wu-btn > p,
|
||||
.wu-trust-item > p {
|
||||
display: contents;
|
||||
}
|
||||
|
||||
/* Cancels Starlight's automatic 1.5rem inter-block margin inside our own grids/rows (it otherwise lands on item 2+ of each row and breaks alignment). */
|
||||
.sl-markdown-content .wu-section,
|
||||
.sl-markdown-content .wu-solution-grid > *,
|
||||
.sl-markdown-content .wu-feature-grid > *,
|
||||
.sl-markdown-content .wu-timeline > *,
|
||||
.sl-markdown-content .wu-problem-list > *,
|
||||
.sl-markdown-content .wu-benefit-list > *,
|
||||
.sl-markdown-content .wu-trust-bar > *,
|
||||
.sl-markdown-content .wu-badges > *,
|
||||
.sl-markdown-content .wu-btn-row > * {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
/* Section shell: full-bleed hairline dividers, alternating tint, 72rem reading width. */
|
||||
.wu-section {
|
||||
margin-inline: calc(-1 * var(--sl-content-pad-x));
|
||||
padding-inline: var(--sl-content-pad-x);
|
||||
border-bottom: 1px solid var(--sl-color-hairline-light);
|
||||
padding-block: clamp(3rem, 4vw + 1.5rem, 5.5rem);
|
||||
}
|
||||
.wu-section--trust {
|
||||
padding-block: 2rem;
|
||||
}
|
||||
.wu-section--tint {
|
||||
background-color: var(--sl-color-gray-7, var(--sl-color-gray-6));
|
||||
}
|
||||
:root:not([data-theme='light']) .wu-section--tint {
|
||||
background-color: color-mix(in srgb, var(--sl-color-gray-6) 60%, transparent);
|
||||
}
|
||||
.wu-section-inner {
|
||||
max-width: 72rem;
|
||||
margin-inline: auto;
|
||||
}
|
||||
.wu-text-narrow {
|
||||
max-width: 44rem;
|
||||
margin-inline: auto;
|
||||
}
|
||||
|
||||
.wu-section-head {
|
||||
max-width: 42rem;
|
||||
margin: 0 auto 2.5rem;
|
||||
text-align: center;
|
||||
}
|
||||
.wu-section-head h2 {
|
||||
margin: 0;
|
||||
font-size: var(--sl-text-3xl);
|
||||
font-weight: 700;
|
||||
letter-spacing: -0.01em;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.wu-section-head p {
|
||||
margin: 0.75rem 0 0;
|
||||
font-size: var(--sl-text-lg);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.wu-section-head.wu-align-left {
|
||||
text-align: left;
|
||||
margin-inline: 0;
|
||||
max-width: none;
|
||||
}
|
||||
|
||||
/* Shields.io / dcbadge release, download, and Discord badges. */
|
||||
.wu-badges {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
.wu-badges img {
|
||||
height: 1.75rem;
|
||||
width: auto;
|
||||
display: block;
|
||||
}
|
||||
|
||||
/* Trust bar: icon + label chips under the hero. */
|
||||
.wu-trust-bar {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
gap: 0.75rem 1.25rem;
|
||||
}
|
||||
.wu-trust-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
font-size: var(--sl-text-sm);
|
||||
font-weight: 500;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.wu-trust-item svg {
|
||||
color: var(--sl-color-accent);
|
||||
width: 1rem;
|
||||
height: 1rem;
|
||||
}
|
||||
|
||||
/* Problem list: bullet-circle + text, left aligned. */
|
||||
.wu-problem-list {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1.1rem;
|
||||
margin: 2.5rem 0 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
}
|
||||
.wu-problem-list li {
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
gap: 1rem;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.wu-problem-list .wu-bullet {
|
||||
flex: none;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 1.5rem;
|
||||
height: 1.5rem;
|
||||
margin-top: 0.15rem;
|
||||
border-radius: 999px;
|
||||
background: var(--sl-color-gray-6);
|
||||
}
|
||||
.wu-problem-list .wu-bullet svg {
|
||||
width: 0.85rem;
|
||||
height: 0.85rem;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
|
||||
/* Solution grid: icon-in-box above title + description. */
|
||||
.wu-solution-grid {
|
||||
display: grid;
|
||||
gap: 2rem;
|
||||
margin-top: 3rem;
|
||||
}
|
||||
.wu-solution {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
.wu-solution-icon {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 2.5rem;
|
||||
height: 2.5rem;
|
||||
border-radius: var(--wu-radius-sm);
|
||||
background: var(--sl-color-gray-6);
|
||||
color: var(--sl-color-accent);
|
||||
}
|
||||
.wu-solution h3 {
|
||||
margin: 0;
|
||||
font-size: var(--sl-text-lg);
|
||||
font-weight: 600;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.wu-solution p {
|
||||
margin: 0;
|
||||
font-size: var(--sl-text-sm);
|
||||
line-height: var(--sl-line-height);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
|
||||
/* Feature grid: wraps <CornerCard> instances. */
|
||||
.wu-feature-grid {
|
||||
display: grid;
|
||||
gap: 1.25rem;
|
||||
margin-top: 3rem;
|
||||
}
|
||||
|
||||
/* Step timeline ("how it works"): connecting line through each numbered circle. */
|
||||
.wu-timeline {
|
||||
position: relative;
|
||||
max-width: 36rem;
|
||||
margin: 3rem auto 0;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 2rem;
|
||||
}
|
||||
.wu-timeline::before {
|
||||
content: '';
|
||||
position: absolute;
|
||||
left: 1.25rem;
|
||||
top: 1.25rem;
|
||||
bottom: 1.25rem;
|
||||
width: 1px;
|
||||
background: var(--sl-color-hairline-light);
|
||||
}
|
||||
.wu-timeline-step {
|
||||
position: relative;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
padding-left: 3.5rem;
|
||||
}
|
||||
.wu-timeline-number {
|
||||
position: absolute;
|
||||
left: 0;
|
||||
top: 0;
|
||||
z-index: 1;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 2.5rem;
|
||||
height: 2.5rem;
|
||||
border-radius: 999px;
|
||||
border: 1px solid var(--sl-color-hairline-light);
|
||||
background: var(--sl-color-bg);
|
||||
font-weight: 700;
|
||||
color: var(--sl-color-accent);
|
||||
}
|
||||
.wu-timeline-step h3 {
|
||||
margin: 0;
|
||||
font-size: var(--sl-text-lg);
|
||||
font-weight: 600;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.wu-timeline-step p {
|
||||
margin: 0;
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.wu-timeline-step code {
|
||||
border-radius: var(--wu-radius-sm);
|
||||
}
|
||||
|
||||
/* Benefit checklist. */
|
||||
.wu-benefit-list {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1rem;
|
||||
margin: 2.5rem 0 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
}
|
||||
.wu-benefit-list li {
|
||||
display: flex;
|
||||
align-items: flex-start;
|
||||
gap: 1rem;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.wu-benefit-list .wu-check {
|
||||
flex: none;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 1.5rem;
|
||||
height: 1.5rem;
|
||||
margin-top: 0.15rem;
|
||||
border-radius: 999px;
|
||||
background: hsl(var(--wu-accent-h) 100% 51% / 0.12);
|
||||
}
|
||||
.wu-benefit-list .wu-check svg {
|
||||
width: 0.85rem;
|
||||
height: 0.85rem;
|
||||
color: var(--sl-color-accent);
|
||||
}
|
||||
|
||||
/* Final call to action. */
|
||||
.wu-cta {
|
||||
text-align: center;
|
||||
}
|
||||
.wu-cta h2 {
|
||||
margin: 0;
|
||||
font-size: var(--sl-text-3xl);
|
||||
font-weight: 700;
|
||||
letter-spacing: -0.01em;
|
||||
color: var(--sl-color-white);
|
||||
}
|
||||
.wu-cta > p:first-of-type {
|
||||
margin: 0.75rem 0 0;
|
||||
font-size: var(--sl-text-lg);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
.wu-cta .wu-btn-row {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
justify-content: center;
|
||||
gap: 0.75rem;
|
||||
margin-top: 2rem;
|
||||
}
|
||||
.wu-cta p.wu-cta-footnote {
|
||||
margin-top: 2rem;
|
||||
font-size: var(--sl-text-sm);
|
||||
color: var(--sl-color-gray-3);
|
||||
}
|
||||
|
||||
/* Grid breakpoints: 1 col mobile, 2 col tablet, 3 col desktop. */
|
||||
@media (min-width: 40em) {
|
||||
.wu-solution-grid {
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
}
|
||||
.wu-feature-grid {
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
}
|
||||
}
|
||||
@media (min-width: 60em) {
|
||||
.wu-solution-grid {
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
}
|
||||
.wu-feature-grid {
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
}
|
||||
.wu-timeline {
|
||||
gap: 2.5rem;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user