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:
@@ -0,0 +1,3 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32">
|
||||
<image href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAACMVJREFUWEeVVwtQVOcV/u69y0uWBJ9YETaA8vCx+AABLWqMiGLEx/jG2um0sR0F2hibGh9RSaeZTtVUE5tIM2lDodM4HRFQJGmgCKiIxEe0jkAiSEBkwxsWdt3dezvfei/ZoFb7z9zZ3bv3nvOd75zz/ecX8N0SAPCS1E8FgAMAP7Xl+t3l9iNfaUdb/C6qNnlPVi+nLdcHdQDcAXioIOwAbOpFIHyR62kgNJuaYzfVLu3z3gMAFgC0L2sPE6EXgOcBDAfgqTruBdAHYEB90RXIUDCPc0w73gB8AAxTg+gB0KnatWm0EyWdj0fkzkXovCWiMb8ZQAcAE4B2AHzxSUA0NhkIbdGxXg1mNIDR8BgzAlFvTsT51HwA9QDaaE+jibSPAhAmLMjZJgWtTnI0F99UqnadQ8e1OgBNAO67ACGFpJKMaM7pmHbo2BfAGAD+0OkDBeOOGHHyz2cLojvsH4/8JYAvVZt9GgAi9gMwVYjP3Kqb9Eqik19b/wNHQ94NpTrjHHpu16ovtapAmB4CYU3QOanWHI+D6GkQJv8iRpySNlvwCR4pCBCUgbZOe9bo3QCqANwlq0MBGIX441t1k7Yscq1rxdo74Lhz4rpyeX8ZBpq+cmGkW80r80uqx0HUGRD6kyjJuH2O4BvuR8eaLXnA1OHI8tsL4BKABgC9Q1MwSZy5f7M0c98GuLzoZEOBoljb++XanGrl6u8qYGklENYHO2U4IAYiZMMMcdqv48URRn9BFFw7zInB0X7jjvxPYwaAKwC+AWB2LULSFwyPUbHi8rLtkm/E+KEgBoH0t/bItX+tVKozKiD3W2FYES5Of+NFcUyUQRBEFuIjS7FbrPbybVmo/YhFeEsF7yxCTXyYw3EAIuA5coYw/c2FYuimqYLHCC9XGgcVSYFiP/1SAe6VfCulNK4R9QHPPdax7HDILWWNcvWBf+P+uQsAbqr0d5E9DQBRM4+s3GAAEwEEwMt/vDBzT6Q4cWOo6Pac+1BGbLk/LIPpfLcu5e4CQR/IAAaXosiyfL+yRb7y1nU0fVYHyOykrwEwdfeYf4qRKwNsnx/o9foISZJCu7u7CYjd4QX9C+PFmLdnSiHrv5cWW27cJZgq+3Qb62cLPi9QyJxL7qrrdVzccRWNp2sAmfrBbun18/Nrb21tvQagEQALeJAByiSFKDhiypR5qVtTd5WUfP7F6YKCW1arlUqoFwKWGHVLCue6smA7GXcZ3zoBxLoCcNRkNcilPy5W8yxNNRoDVq9eE9Xe1lZz9OiRIwBq1Fa2aAxwD6AEh4WFhSXs2buPvaqYTK1tO3/zeo7NZrMJgS8bdYsLFj0GQL9uY/2s7wGo+0edXLKhkHKbsmlzfEJCwhxJkqQLFy+UvH/svfdUIaKeDCohhWQkgEkTJkxYsm9/xnZSabVaH6Ru2/YXi6W/RzAsm6xLzF/yTAC++qRWLl5/hmqZnv5qUvSs6Km0V1FeVn78+AfHAFwF0OIKgAwQwGQVwK/4gsVisaWlbv2bxWLpEAzJEbrEvKT/E4CSlpa+eFZM7CTaKy87V5GZefx9VQdYiP2uW6YGIGnf/gxXAH+3WCxtgiE5/NkBnKiRi9edpdNtqemJsbGxEUMAfKF2wvdSMIIaEBQUtPhAxm9fEwRBVBk4YbFYWhG4LES3OC9ZEL5TOFtuXBVMleZHivDrT27Ln68nALfUtPRFMTGxoQRwrrS07MMPM/+kpoAMDBYha4BKGOrr67vg4MHDb3h4enrabDbH7l07C1paWhrgHThct+72BsHNi+lyLltuXCVMlb26lIY5gt7AtnVKtuP6Hy4pl16n6Pjs2rN3aUR4BAUOnxYVnc3OzvqzWoTcXQcBcAxjGwYBiD106J09Y/z8uDsqOdnZl4uKCkmZXZi2d4Y0Y2e04DbMCcKWF1+K+xUUooUUIoXq03qxWS5a9imsHWZvb++xBw8eTtb7+FAjlCNH/5hZXVV1CsB/1HnA6qqEVDJ/ANN/9sqWLfPmzZ9HJyaTqWfP7t1nBwbMHCAEDJ8ySozOMIqBS0PsRctOo+mzNinlm7Ww9T+Qr/3+ulL78R3AQeEZtmFjSkxS0tIpfK+rq6tzx2uvvm21WskMZwxK8aASEog2lIT7+/u/yEL08vJyIr9x80bTsXePXjCbzZyQrM4t2G+uNyytXeiu6UXYT8NQl90OmX+Boua9cGFCxMZNP4py0+n4Wyk6W/ivnJzsLABUQsqymRuk6xzHBzm7BQCIXLdu/fqlLy9LZDE+FCVTT37+qS/Ly8rrZNlBIIyAMsthVRtGnh8fEDBu7Zq1kcbIaQZJkpw7Y/O9e81vHdj3rtls5hzAvYAjHtEqrgA0FtiOwaIoGlPT0jdHRUVHaZWvKIrS3NzUXlCQf6Xy4sUaWZY5XHIs048dOy5g5aqV06OiooPd3d1Z1M6a7Ozs6Hzn8KGP6uvrzwO4rY52lHfnyD90fmcxknZON8Gim9vkTSmbkufPmx/v5uamGYUsy3JDQ4PpVO7Jm42Nd/tWrFgVGhsXF+Lp6ck0aku529BwNzPzgxONjY2X1byz9cga58lHzgV8kYCcOVSVkekICQ+PmL5y5aqXwsLDJ0iSxP8f7nqyLNtsdtnDw33wHg23t7d1lhQXVxQWnimz2+0sOM5/bDs6d1L/JAC0y7zRoHZOYDuyOwyRkdMik5evmBsSEhKk5dc14u7urp7S0tKqwjOnz/f3999Rxy5qPnPOomPkrJnBw80jc5tqkCCYDva7VmAPh04gYNasmGnJycvnBgQGBoiiKJrNfb3lZeXVeXm55/v6+uiYZwpGzGLVDjacHQcj14A/CYCWDo0N5pZKR7UkkLEcXhISEqcaDIFjT57MvdzR0cYhg9FyUKVjbWynY+2M+cix7n8B0EDwk2wwLRoQqibBcIrifzwxccJha7pG/ETHz8LA0Ge0nVM7xLJGmCKyxNyyuHhpET/TYfZpDDwOqAaEkWtHeTpjtEMjftpJGv8FiVSZj/q1694AAAAASUVORK5CYII=" width="32" height="32"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.2 KiB |
Reference in New Issue
Block a user