Open
Conversation
Comment on lines
+80
to
+84
| - Source: GitHub Actions | ||
| - The website is built automatically from `docs/` directory | ||
| - No generated HTML files are stored in the repository | ||
|
|
||
| Every push to `main` that updates the `site/` directory updates the public website. | ||
| Every push to `main` that updates the `docs/` directory automatically updates the public website. |
Contributor
There was a problem hiding this comment.
This is the more complicated approach. It looks to me there are three approaches:
- easiest for now: Store generated HTML in main branch but it has to be in the
/docsdirectory. We have to setsite_dir: docsanddocs_dir: <any other dir>in mkdocs.yml. Info here: https://www.mkdocs.org/user-guide/configuration/#docs_dir - mid complicated: Use
mkdocs gh-deployon your machine - it should store generated HTML to different branch which will be than set in Pages settings - most complicated setup, but the best "user experience" in the long term: custom GitHub Action - it will probably run
mkdocs gh-deployby itself but it needs to be setup and tested
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
2 participants
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.
No description provided.