docs(site): scaffold MkDocs Material homepage#37
Merged
Conversation
Add a public documentation site built with MkDocs Material and deployed via GitHub Pages, kept separate from the internal ./docs tree. - mkdocs.yml with docs_dir: website (./docs stays internal, unpublished) - Catppuccin Macchiato (blue accent) theme override stylesheet - GitHub Actions workflow for Pages build and deploy - Placeholder pages for Getting Started, Features, Usage, Reference - Ignore MkDocs build output (site/) No existing documentation moved, renamed, or deleted.
Fill in the MkDocs Material site under website/ with real content across all sections, and switch navigation to a classic left sidebar. - Home, Getting Started, Installation, Philosophy - Features: shell, git, terminal, editor, packages, scripts - Usage: daily workflow, aliases, functions, taskfile - Reference: structure, Stow, shell dependencies, supported systems, troubleshooting - Completions documented (fzf-tab, task, herdr); Herdr auto-load noted - Embed nine screenshots and add a screenshots gallery - AI-assistance acknowledgement on the Philosophy page Sourced from existing docs/ guides and stow/ package files; docs/ untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Scaffolds a public documentation site built with MkDocs Material, deployed via GitHub Pages. Kept fully separate from the internal
./docstree, which is left untouched.What's included
mkdocs.yml—docs_dir: website, so./docsis never published.website/assets/stylesheets/catppuccin-macchiato.css..github/workflows/docs.yml— GitHub Actions build + deploy to Pages (push tomain+ manualworkflow_dispatch).site/added to.gitignore.Not included (intentional)
./docscontent yet.After merge
Test locally
```bash
docker run --rm -it -p 8000:8000 -v "$PWD":/docs squidfunk/mkdocs-material serve --dev-addr=0.0.0.0:8000
```