https://github.com/hellozeronet/documentation

ZeroNet Documentation
https://github.com/hellozeronet/documentation

Last synced: 2 months ago
JSON representation

ZeroNet Documentation

• Host: GitHub
• URL: https://github.com/hellozeronet/documentation
• Owner: HelloZeroNet
• License: gpl-2.0
• Created: 2015-03-09T00:48:34.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-05-15T20:50:57.000Z (over 1 year ago)
• Last Synced: 2024-10-14T09:46:31.105Z (3 months ago)
• Language: JavaScript
• Homepage: https://zeronet.readthedocs.org/
• Size: 2.49 MB
• Stars: 75
• Watchers: 16
• Forks: 107
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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

```