Writing Documentation¶

This page discusses how to contribute documentation for Docuisine. We use Zensical to write documentation by using markdown syntax. We use GitHub Pages to host the documentation website.

Getting Started¶

Note

Installing git, uv and Python are essential requirements to work with this project. If you don't have Python 3.13 on your machine, simply write uv python install 3.13 on your favourite terminal.

Clone the git repository of the project

git clone https://github.com/docuisine/documentation.git

Move into the directory
```
cd documentation
```
Install dependencies
```
uv sync
```

Start the local documentation server and start writing!

make docs   # Runs the docs server at http://localhost:7000

Tip

Optionally, run the actual command uv run zensical serve and add the argument -a to specify an address and port for the server to run on. Example: uv run zensical serve -a 0.0.0.0:7000, this runs on http://localhost:7000 or http://0.0.0.0:7000

Formatting¶

It is imperative to read the official Zensical documentation if you need to use features such as content tabs, grids, diagrams, advanced formatting, etc.

Configuration¶

If a change in the project configuration file zensical.toml is needed, read this relevant documentation for a detailed manual.