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

Support documentation in multiple human languages #185

Closed
maurelian opened this issue Oct 24, 2018 · 1 comment
Closed

Support documentation in multiple human languages #185

maurelian opened this issue Oct 24, 2018 · 1 comment

Comments

@maurelian
Copy link
Contributor

maurelian commented Oct 24, 2018

About the ConsenSys Smart Contract Best Practices

Our best practices are the most popular security reference for smart contract developers. We're looking for help maintaining and expanding them.

User story

As a user, I would like to be able to translate and visit the site in a non-english language.

Task

We have had two amazing translation contributions, which added Chinese, and Korean.

This site uses MKDocs, which is pretty great, but

MkDocs doesn't support language toggling/branching, so Material cannot add this functionality either. To solve this, you would need to build two separate versions of your docs, one for each language configuring the correct search language in mkdocs.yml. By customizing the theme you could link to the other language inside the header or where you want, effectively switching between the two separate builds.

squidfunk/mkdocs-material#867 (comment)

This seems like a reasonable option.

Specs:

  • have each language accessible at it's own url path (ie. appending /zh or /kr).
  • Each new language's docs should be hosted in this repo, but separate builds are required.
  • A language selector should be available from the header
@maurelian maurelian changed the title Make the site support multiple human languages Support documentation in multiple human languages Oct 24, 2018
@shayanb
Copy link
Contributor

shayanb commented Jan 24, 2019

Duplicate: #162

@shayanb shayanb closed this as completed Jan 25, 2019
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

No branches or pull requests

2 participants