Cryptomator's Documentation

This is the source repository of Cryptomator's documentation.

Contributing

We prefer contributions to our documentation to be in English, but if you wish to contribute in another language, please contact us.

Steps to Contribute

• Clone this repo
• Make your changes
• Preview changes and clear errors by following our guide below
• Send us a pull request

Ways to Preview Changes and Build Site

Using Docker

• Install Docker

  For live preview:

  docker compose up
  

  The live preview will be available at: http://localhost:8000/

  To build site:

  docker compose exec cryptomator-docs sphinx-build -M dirhtml /source /build/dirhtml
  

Without Using Docker

• Install pip

• Install sphinx, sphinx_rtd_theme, and sphinx-autobuild

  pip install sphinx sphinx_rtd_theme sphinx-autobuild
  

  For live preview:

  make clean livehtml
  

  To build site:

  make clean dirhtml