Repository navigation
Publish docs/ as a site on GitHub Pages - #123
Merged
Merged
Conversation
MkDocs Material builds docs/ with --strict, so a broken link or a page missing from the nav fails the build. Pull requests that touch the docs run the build; a push to main also deploys it through GitHub's Pages actions, with no write access to the repository and no gh-pages branch. The theme uses system fonts: its default loads Google Fonts, which hands every visitor's address to Google. mkdocs and mkdocs-material are pinned; MkDocs 2.0 drops the plugin and theme system Material is built on.
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
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.
Follows #122. MkDocs Material builds
docs/into a site at https://t-crypt.github.io/berth/ with search, a sidebar and a phone layout. The Markdown stays the source, so GitHub keeps rendering the same pages.mkdocs build --strictruns on every PR that touches the docs. A broken link or a page missing from the nav fails it.maindeploys through GitHub's Pages actions (upload-pages-artifact,deploy-pages). The workflow getscontents: read. Only the deploy job getspages: write, and nogh-pagesbranch is created.mkdocs1.6.1 andmkdocs-material9.7.7 are pinned indocs/requirements.txt. MkDocs 2.0 removes the plugin and theme system Material is built on, so an unpinned install would break once it ships.Before the first deploy, Pages needs its source set to GitHub Actions (Settings, Pages). Until then the build job passes and the deploy job fails.
Proof:
mkdocs build --strictpasses locally on these pages. The output has every page, search and a sitemap, and no Google Fonts request.