README.md

Cryptomator Documentation

Official documentation site for Cryptomator. Built with Docusaurus.

Contributing

We welcome contributions! Please read our contributing guidelines for details on how to help.

Quick Start

npm install
npm start

Opens dev server at http://localhost:3000 with live reload.

Structure

• docs/desktop/ - Desktop app documentation
• docs/android/ - Android app documentation
• docs/ios/ - iOS app documentation
• docs/hub/ - Cryptomator Hub documentation
• docs/security/ - Encryption architecture and security details
• docs/misc/ - Additional resources

Scripts

npm run build # Build static site
npm run serve # Serve built site locally

Other scripts can be found in package.json.

Deployment

Deployed to docs.cryptomator.org via GitHub Pages from the main branch.

License

This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0).