ZeroNet Documentation
Go to file
ZeroNet 1cfdea9ecb
Update docs.css
2020-09-01 20:39:15 +02:00
docs Update docs.css 2020-09-01 20:39:15 +02:00
example/ZeroFrame Simple database example, Output writes messages to top 2015-05-06 00:40:23 +02:00
.gitignore Make index work offline 2016-03-15 23:32:24 -03:00
LICENSE Initial commit 2015-03-09 01:48:34 +01:00
README.md Many fixes to ZeroFrame API Page and Wrapper section 2018-12-16 17:36:26 +00:00
mkdocs-fr.yml update mkdocs-fr for it to be similar to english 2020-03-19 15:27:55 +01:00
mkdocs-it.yml Translation to italian language 2019-11-26 10:21:51 +01:00
mkdocs-readthedocs.yml Update mkdocs-readthedocs.yml 2020-09-01 20:22:58 +02:00
mkdocs-zh.yml index.md completed 2018-12-11 18:20:42 +08:00
mkdocs.yml Display main categories on the left side instead of the top 2019-08-08 16:49:32 +02:00
readthedocs.yml Update readthedocs.yml 2020-09-01 19:12:39 +02:00
requirements.txt Update requirements.txt 2020-09-01 20:17:30 +02:00
start.py Updated to make it compatible with latest mkdocs chages 2015-06-19 00:02:43 +02:00
start.sh Added Vagrant to documentation 2015-05-26 21:45:10 +02:00

README.md

Available at https://zeronet.io/docs

Building

First install the following from pip:

  • mkdocs
  • mkdocs-material
  • pymdown-extensions

Then simply run mkdocs serve to host a local version of the docs, or mkdocs build to output a static version.

French doc

Serve:

mkdocs serve -f mkdocs-fr.yml

Build: mkdocs build -f mkdocs-fr.yml -d site-fr

Create a new translation

You will need to duplicate the mkdocs.yml file and rename it to add the language code according to ISO 639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) it is used for. Example : mkdocs-fr.yml

Modify the default lang for lunr search :

plugins:
  - search:
      lang: ['fr']

Modify the language theme to fit the one you translate it for. Example :

theme:
  language: 'de'

Translate the nav is willing language.

Now in docs duplicate the folder en/ and rename it with appropriate language code. Example : fr/

Now you can translate the documentation. Thank you.

Generate all the doc files

mkdocs build -f mkdocs.yml & mkdocs build -f mkdocs-fr.yml