docmost/README.md

52 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

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> |
<a href="https://docmost.com/docs"><strong>Documentation</strong></a>
</p>
</div>
<br />
> [!NOTE]
> Docmost is currently in **beta**. We value your feedback as we progress towards a stable release.
## Getting started
2024-06-28 17:29:46 +01:00
To get started with Docmost, please refer to our [documentation](https://docmost.com/docs).
## Features
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
- 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>
### 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)