Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: add MkDocs to build HTML and github actions to deploy the docs #122

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

mlisovyi
Copy link

@mlisovyi mlisovyi commented Apr 16, 2023

Main changes:

Minor:

  • dropped cross-references between translations to reduce maintenance burden. The links to individual translations (locally in the repo and externally in others) are all linked in the HTML docs in the left panel.
  • Added a soft link to the main README in translations, as it is needed by mkdocs
  • Downgrade all sections from level-1 to level-2 in order to include them in the TOC in the right pannel

Link to the documentation built in a fork
The final result looks like this (dark-mode version):
Screenshot 2023-04-16 at 15 09 02

P.S. implementing it with a proper multi-lingual page would require more changes to the repository structure + would not allow to link external translations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant