- [Node.js](https://github.com/asdf-vm/asdf-nodejs) `v10.15.0` to support the other required tools
- [docsify](https://docsify.js.org/#/) to create our documentation site
- [prettier](https://prettier.io/) to format our markdown files
### Install Dependencies
We are trying to **avoid polluting** the core repo with tooling for this documentation site. As such, it would be great if you could install these development tools **globally** so we don't need to commit them to this project.
```shell
npm i docsify-cli prettier -g
```
## Serve the Site
From the root of this repo run:
```shell
docsify serve docs
```
## Format before Committing
From the root of this repo run:
```shell
prettier --write "docs/**/*.md"
```
## Translations
It would be great to provide translations for other languages.
Docsify makes adding new languages quite easy. Look in `docs/index.html` for commented out `zh-cn` examples.
### Adding a new Translation
1. create a folder in `docs/` for the new translation
```
docs/
docs/zh-cn/
```
2. copy file from root `docs/_404.md` to new folder `docs/zh-cn/_404.md`
```
docs/_404.md
docs/zh-cn/_404.md
```
3. replace text with translated text.
4. repeat for all files.
5. add a link to the new translation in `_navbar.md`.
6. run `prettier` before committing.
For more information, see the [Configuration](https://docsify.js.org/#/configuration) docsify docs, the [Custom navbar](https://docsify.js.org/#/custom-navbar) docsify docs, and have a look at their own `index.html`'s [search section](https://github.com/docsifyjs/docsify/blob/6ac7bace213145cb655e9a5e9e209384db08e5f9/docs/index.html#L48).
