foliea/arkis-docs

Arkis Documentation (deprecated)

Arkis Documentation

Arkis documentation is available online here.

This documentation is written using Markdown.

Hack

To hack on this documentation, you can directly use any markdown editor of your choice (including directly editing the file on GitHub).

This documentation is built using MkDocs.

If you want to preview a live version of this documentation, all you need is Docker and Make.

Run the documentation server inside a container

make

Clean the container

make clean

Rebuild and restart the documentation server

make re

Run a live reload development environment

make dev

Open a shell in this development environment

CMD=/bin/bash make dev

Open the documentation

The documentation should be running on your Docker host and available at:

http://$(your-docker-ip):$PORT

You can run the documentation server on another port of your Docker host by specifying the environment variable PORT (default: 8000) before any of the previous commands (except clean).

Deploy the documentation on GitHub Pages

make deploy

Caution! You need push access to the targeted repository to deploy this documentation. The path $HOME/.ssh is mounted inside the container with a volume for that purpose.

Contributing

See the contributing guidelines.

Licensing

arkis-docs is licensed under the MIT License. See LICENSE for full license text.