Repository navigation
Conversation
site/build.sh builds the site with MkDocs Material from the README, docs/guide.md, docs/integrations/ and rules/README.md, so no page is written twice. The site also serves the get.sh of the latest release. The pages workflow builds the site on a pull request and publishes it from main. The release workflow starts a run after each release. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
|
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.
Summary: Add a small docs site that is built from the Markdown files already in the repo, and a workflow that publishes it to GitHub Pages.
Changes:
site/build.shcopies the README,docs/guide.md,docs/integrations/andrules/README.mdinto a build folder, rewrites the links between them, and runs MkDocs Material with--strict. Links to other repo files point to GitHub..github/workflows/pages.ymlbuilds the site on a pull request that touches those files, and publishes it from main. The site also serves theget.shof the latest release, after checking it againstSHA256SUMS.get.sh.site/selects lint only.After the merge: turn on Pages for the repo with GitHub Actions as the source. The custom domain is a later change.
Note: Material for MkDocs gets fixes until May 2027. Its successor, Zensical, reads the same
mkdocs.yml.