chill-bundles/docs/README.md

Chill documentation

Documentation of the Chill software.

The compiled documentation may be read at http://docs.chill.social

Compilation into HTML

To compile this documentation :

1. Install MkDocs and MkDocs Material

           $ virtualenv .venv # creation of the virtual env (only the first time)
           $ source .venv/bin/activate # activate the virtual env
   (.venv) $ pip install -r requirements.txt
   

2. Install submodules : $ git submodule update --init;
3. run make html or mkdocs build from the root directory
4. The base file is located on site/index.html

   $ cd site
   $ python -m http.server 8888 # will serve the site on the port 8888
   

Alternatively, you can use the built-in development server:

(.venv) $ mkdocs serve

This will start a development server at http://127.0.0.1:8000/ with live reload.

Contribute

Issue tracker : https://gitlab.com/Chill-Projet/chill-bundles/-/issues

Licence

This documentation is available under the GNU Free Documentation Licence.