Repository navigation
Serve the website without Jekyll - #68
Merged
Merged
Conversation
GitHub Pages serves docs/ from main and by default runs Jekyll over it first, which would make a page of each markdown file with front matter at the address of the page build_docs.py builds from it. An empty docs/.nojekyll turns Jekyll off, and check_site.py fails without it.
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.
The repository is public now, so GitHub Pages can serve the website from
main, folder/docs, as.github/workflows/docs.ymlsays. Deploying from a branch, Pages runs Jekyll over the folder first. The markdown sources sit next to the pages built from them, and they keep their front matter from the MkDocs days (docs/user-guide/report.mdstarts with---), so Jekyll would make a page of each at the address of the pagetools/build_docs.pybuilds from it.docs/.nojekyll, empty, turns Jekyll off, so Pages serves every file as it is.tools/check_site.pyfails when it is missing (checked by taking it away).docs.ymland the contributing page say why it is there.tools/build_docs.py --checkandtools/check_site.pypass.