Documentation

How to maintain this documentation

The documentation is written in Markdown and is built using HonKit. The documentation is hosted on GitHub Pages.

• First install HonKit following the installation guide.

• Then, in the docs folder at the root of the project, run npx honkit serve to build the documentation and serve it locally. The changes will be automatically updated in the browser.

• Do your changes by editing the Markdown files in the docs folder.

• To build the documentation, run npx honkit build in the docs folder. The documentation will be built in the _book folder.

• Replace the html and json files in the docs folder with the html files in the _book folder. Do se same with gitbook folder.

• Commit and push the changes.

Troubleshooting

• To solve plugins problems checkout this

• When modifying SUMMARY.md you have to delete _book folder and restart the server.