CryptPad Documentation

Installation

We use UV to maintain the development environment for the documentation. Install dependencies with

uv sync

Activate the environment with

source ./.venv/bin/activate

Lucide icons

Following the product in 2025.9.0, the documentation uses Lucide icons since 2026.5.0.

Icons usage in RST:

• |name| — old Fontawesome shortcut for an icon "name", now mapped to a Lucide icon (see shortcut_icon_map in icon_mappings.py)
• |cptools name| — old CPTools shortcut for an icon "name" (custom web font), now mapped to a Lucide icon (see cptools_icon_map)
• |icon name| — Lucide icon "name" (new)

To add or change a shortcut mapping, edit icon_mappings.py and rebuild. No .rst or .po change is needed unless you introduce a new shortcut string.

Lucide names are listed in conf_icons.py, generated from _themes/theme/static/js/lucide.min.js:

python scripts/generate_lucide_icons.py

Run again after replacing lucide.min.js.

Admonitions, permalinks, and sidebar expand/collapse are handled by lucide-theme.js. Their icon names are set in icon_mappings.py / conf.py (html_context to lucide_theme_config). Other theme UI (prev/next, breadcrumbs, mobile menu) uses Lucide in the templates under _themes/theme/.

Build

English en is the default language.

to build the default:

make html

to build another language, e.g. French:

make -e SPHINXOPTS="-D language='fr'" html

View the result in /_build/html/

Translations

If you are interested in translating this documentation, you can use our Weblate project for the user guide. If your language is not listed, please contact the development team to add it.

To add a new language

sphinx-intl update --pot-dir _build/gettext -l de

change de to the locale you want to add

Translated builds

To update after default language has changed:

sphinx-intl update -p _build/locale

To generate .po files for a new language e.g. French:

make gettext
sphinx-intl update -p _build/gettext -l fr

update.sh updates all languages after English has changed:

./update.sh

build.sh builds all languages into the www folder:

./build.sh

Adding a language

1. add language code to LANG and leave an empty line at the end of the file
2. add the <option> to _themes/theme/layout.html line 109

translated images

Images for English are in the /images folder.
To provide localised versions of images, place them in a folder such as images/fr/.

Licenses

The content of this documentation is licensed under the Creative Commons Attribution 4.0 International (CC-BY).

The theme is modified from the Krita documentation and licensed under the GNU Free Documentation License.