Comments (14)
That doesn't sound too bad. Perhaps a little translation icon to the right of the Github stats in the header which one can click for a dropdown of all available languages?
How will the folder structure of the repo change (if at all)?
from documentation.
mkdocs-material seems to support localization : https://squidfunk.github.io/mkdocs-material/getting-started/#localization
from documentation.
@rllola Ah, was looking for this in the material documentation, thanks!
from documentation.
Actually, it doesnt seems to be the best way of doing according to the creator :
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.
Might be better to create 2 differents documentation as suggested ? I am starting on the french translation. And will see if I cannot configure the nav field to redirect to the french.
from documentation.
It is also mentioned here : https://www.mkdocs.org/user-guide/configuration/#lang
from documentation.
Interesting, OK. I'd recommend holding back on the ZeroFrame API docs as I'm currently overhauling them.
from documentation.
Ok, cool. I played a little with the template. We just need to find the best place to show the link for the different languages.
An advantage with doing one documentation for each is that the search engine won't show all the results in all the language and getting smaller page (so faster to show).
However we need to find the best structures for it and write some scripts for easy update.
from documentation.
I was thinking of something like this ? Each language has its own folder but the bitcoinbar
element might need to be moved...
├── docs
│ ├── docs.css
│ ├── docs.js
│ ├── en
│ │ ├── bitcoinbar
│ │ │ ├── bitcoinbar.css
│ │ │ ├── bitcoinbar.js
│ │ │ └── demo.html
│ │ ├── faq.md
│ │ ├── help_zeronet
│ │ │ ├── coding_conventions.md
│ │ │ ├── contributing.md
│ │ │ ├── donate.md
│ │ │ └── network_protocol.md
│ │ ├── index.md
│ │ ├── site_development
│ │ │ ├── cert_authority.md
│ │ │ ├── content_json.md
│ │ │ ├── dbschema_json.md
│ │ │ ├── getting_started.md
│ │ │ └── zeroframe_api_reference.md
│ │ └── using_zeronet
│ │ ├── create_new_site.md
│ │ ├── installing.md
│ │ └── sample_sites.md
│ ├── fr/ (french doc)
│ ├── img/
│ ├── jquery.min.js
│ └── logo/
├── example/
├── LICENSE
├── mkdocs.yml
├── README.md
├── start.py
├── start.sh
└── theme/
EDIT: And +1 for the translation icon in the header.
from documentation.
Yes, ideally we wouldn't copy anything besides the *.md
files. Alright, this seems like enough to start a preliminary PR with. Do you want to take the lead on that?
We still need someone to design the button with the dropdown menu, I might refer to @HelloZeroNet on that one as he's better at design that I?
from documentation.
Yes sure.
For the dropdown menu we can just use the design from the material theme. Maybe it can redirect also to an actual page with link to help on translation, etc...
I have a couple of ideas. I can play around and post the result here ?
from documentation.
I was thinking a dropdown menu from the button, but perhaps the last item could have a divider line with a link to a page about translating? Like Translation HowTo
?
from documentation.
Sounds good
from documentation.
First draft
from documentation.
This can be closed. Multi-language is now supported for the documentation.
from documentation.
Related Issues (20)
- Is Documentation accessible to everyone ? HOT 1
- Description of PoW based ID providers needed HOT 1
- Missing logo on english documentation HOT 5
- Support Chinese Search HOT 1
- Code example for signing content.json HOT 1
- Namecoin example should be updated HOT 1
- Documentation of Multiuser plugin
- Document the different types of ZeroFrame responses (in WebSocket)
- Make JavaScript the default for examples HOT 1
- Document feeds section of content.json
- How does Zeronet work with Tor? HOT 2
- Namecoin buy tip not work anymore
- Broken link in FAQ HOT 1
- Instructions to use with Tor Browser in the FAQ are out of date HOT 1
- [INF] Working on Italian version HOT 3
- Update the faq ZH version
- MORE SCREENSHOTS on Intro Page Leads to 404 HOT 1
- tor section is outdated HOT 2
- Zeronet with Tor on Linux - more universal and work instructions
- build documentation fails HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from documentation.