feat: Support i18n for documentation #34
Merged
Conversation
This file contains 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
This commit overhauls the project structure and build process to support documentation in both official languages. Because of the limitations of `mkdocs`, it is necessary to treat each language as a distinct site. The general approach used here is to `mkdocs build` each language, then copy over a static landing page. * One folder under `docs/` per language for content * One config file per language at the project root * One output folder per language at `site/<lang>` * Images are no longer shared, as they generally have unilingual text Having multiple sites means `mkdocs gh-deploy` is no longer effective. So the CI configuration was also updated to a generic GitHub action for publication of a directory to the `gh-pages` branch.
brendangadd
added
kind/docs
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.
This commit overhauls the project structure and build process to support
documentation in both official languages. Because of the limitations of
mkdocs, it is necessary to treat each language as a distinct site. Thegeneral approach used here is to
mkdocs buildeach language, then copyover a static landing page.
docs/per language for contentsite/<lang>Having multiple sites means
mkdocs gh-deployis no longer effective.So the CI configuration was also updated to a generic GitHub action for
publication of a directory to the
gh-pagesbranch.