2024-06-28 17:29:46 +01:00
|
|
|
<div align="center">
|
|
|
|
|
<h1><b>Docmost</b></h1>
|
|
|
|
|
<p>
|
|
|
|
|
Open-source collaborative wiki and documentation software.
|
|
|
|
|
<br />
|
|
|
|
|
<a href="https://docmost.com"><strong>Website</strong></a> |
|
2025-04-21 21:50:21 +01:00
|
|
|
<a href="https://docmost.com/docs"><strong>Documentation</strong></a> |
|
|
|
|
|
<a href="https://twitter.com/DocmostHQ"><strong>Twitter / X</strong></a>
|
2024-06-28 17:29:46 +01:00
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
## Getting started
|
2025-03-06 17:59:22 +00:00
|
|
|
|
2025-04-21 21:50:21 +01:00
|
|
|
To get started with Docmost, please refer to our [documentation](https://docmost.com/docs) or try our [cloud version](https://docmost.com/pricing) .
|
2024-06-28 17:29:46 +01:00
|
|
|
|
|
|
|
|
## Features
|
2025-03-06 17:59:22 +00:00
|
|
|
|
2024-06-28 17:29:46 +01:00
|
|
|
- Real-time collaboration
|
2024-09-04 18:56:14 +01:00
|
|
|
- Diagrams (Draw.io, Excalidraw and Mermaid)
|
2024-06-28 17:29:46 +01:00
|
|
|
- Spaces
|
|
|
|
|
- Permissions management
|
|
|
|
|
- Groups
|
|
|
|
|
- Comments
|
|
|
|
|
- Page history
|
|
|
|
|
- Search
|
2025-03-06 17:59:22 +00:00
|
|
|
- File attachments
|
|
|
|
|
- Embeds (Airtable, Loom, Miro and more)
|
|
|
|
|
- Translations (10+ languages)
|
|
|
|
|
|
|
|
|
|
### Screenshots
|
2024-06-28 17:29:46 +01:00
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
<img alt="home" src="https://docmost.com/screenshots/home.png" width="70%">
|
|
|
|
|
<img alt="editor" src="https://docmost.com/screenshots/editor.png" width="70%">
|
|
|
|
|
</p>
|
|
|
|
|
|
2025-03-06 17:59:22 +00:00
|
|
|
### License
|
|
|
|
|
Docmost core is licensed under the open-source AGPL 3.0 license.
|
|
|
|
|
Enterprise features are available under an enterprise license (Enterprise Edition).
|
|
|
|
|
|
|
|
|
|
All files in the following directories are licensed under the Docmost Enterprise license defined in `packages/ee/License`.
|
|
|
|
|
- apps/server/src/ee
|
|
|
|
|
- apps/client/src/ee
|
|
|
|
|
- packages/ee
|
|
|
|
|
|
|
|
|
|
### Contributing
|
|
|
|
|
|
2024-09-04 18:56:14 +01:00
|
|
|
See the [development documentation](https://docmost.com/docs/self-hosting/development)
|
2025-04-21 21:50:21 +01:00
|
|
|
|
|
|
|
|
## Thanks
|
|
|
|
|
Special thanks to;
|
|
|
|
|
|
|
|
|
|
<img width="100" alt="Crowdin" src="https://github.com/user-attachments/assets/a6c3d352-e41b-448d-b6cd-3fbca3109f07" />
|
|
|
|
|
|
|
|
|
|
[Crowdin](https://crowdin.com/) for providing access to their localization platform.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<img width="48" alt="Algolia-mark-square-white" src="https://github.com/user-attachments/assets/6ccad04a-9589-4965-b6a1-d5cb1f4f9e94" />
|
|
|
|
|
|
|
|
|
|
[Algolia](https://www.algolia.com/) for providing full-text search to the docs.
|
|
|
|
|
|
