Welcome to Docs!
Docs is an open-source document editor, where your notes can become knowledge through live collaboration.
It offers a scalable and secure alternative to tools such as Notion, Outline, or Confluence
Chat on Matrix - Documentation - Getting started - Reach out
Docs is a collaborative text editor designed to address common challenges in knowledge-building and sharing.
- 😌 Docs offers simple, accessible online editing to all
- 💅 Create clean documents with beautiful formatting options
- 🖌️ Focus on your content using either the in-line editor, or the Markdown syntax
- 🧱 Docs is built for productivity, with many block types accessible from the
/slash commands, as well as keyboard shortcuts. - 🔌 Need to write while offline? No problem! Keep writing, your edits will get synced once you're back online
- ✨ Save time thanks to our AI actions, such as rephrasing, summarizing, fixing typos, translating, or even turn your text into a prompt!
- 🤝 Enjoy live editing! Collaborate with your team in real time
- 🔒 Granular access control to ensure your information is secure and only shared with the right people
- 📑 Export your content in multiple formats (
.odt,.doc,.pdf) with customizable templates - 📚 Coming soon! Built-in wiki functionality to turn your team's collaborative work into organized knowledge
- 🚀 Anyone can install Docs on their server, provided you have the necessary configuration
Test Docs on your browser by logging in on this environment
email: [email protected]
password: I'd<3ToTestDocs
⚠️ The methods described below for reunning Docs locally using is for testing purposes only. It is based on building Docs using Minio as the S3 storage solution. You can choose the S3-compatible object storage solution of your choice.
Prerequisite
Make sure you have a recent version of Docker and Docker Compose installed on your server. Use these commands to check for versions:
$ docker -v
Docker version 20.10.2, build 2291f61
$ docker compose version
Docker Compose version v2.32.4
⚠️ You may need to run the following commands withsudo, but this can be avoided by adding your user to the localdockergroup.
Project bootstrap
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap FLUSH_ARGS='--no-input'
This command builds the app container, installs dependencies, performs database migrations and compiles translations. It's a good idea to use this command each time you are pulling code from the project repository, to avoid dependency-related or migration-related issues.
Your Docker services should now be up and running 🎉
You can access the project by going to http://localhost:3000.
You will be prompted to log in, the default credentials are:
username: impress
password: impress
📝 Note that if you need to run them afterwards, you can use the eponym Make rule:
$ make run
To do so, install the frontend dependencies with the following command:
$ make frontend-development-install
And run the frontend locally in development mode with the following command:
$ make run-frontend-development
To start all the services, except the frontend container, you can use the following command:
$ make run-backend
Adding content
You can create a basic demo site by running this command:
$ make demo
Finally, you can check all available Make rules using this command:
$ make help
Django admin
You can access the Django admin site at:
You first need to create a superuser account:
$ make superuser
We'd love to hear your thoughts, and hear about your experiments, so come and say hi on Matrix.
Want to know where the project is headed? 🗺️ Checkout our roadmap
This work is released under the MIT License (see LICENSE).
While Docs is a public-driven initiative, our licence choice is an invitation for private sector actors to use, sell, and contribute to the project.
This project is intended to be community-driven, so please do not hesitate to get in touch if you have any question related to our implementation or design decisions.
You can help us with translations on Crowdin.
If you intend to make pull requests, see CONTRIBUTING for guidelines.
docs
├── bin - executable scripts or binaries that are used for various tasks, such as setup scripts, utility scripts, or custom commands.
├── crowdin - for crowdin translations, a tool or service that helps manage translations for the project.
├── docker - Dockerfiles and related configuration files used to build Docker images for the project. These images can be used for development, testing, or production environments.
├── docs - documentation for the project, including user guides, API documentation, and other helpful resources.
├── env.d/development - environment-specific configuration files for the development environment. These files might include environment variables, configuration settings, or other setup files needed for development.
├── gitlint - configuration files for `gitlint`, a tool that enforces commit message guidelines to ensure consistency and quality in commit messages.
├── playground - experimental or temporary code, where developers can test new features or ideas without affecting the main codebase.
└── src - main source code directory, containing the core application code, libraries, and modules of the project.Docs is built on top of Django Rest Framework, Next.js, BlockNote.js, HocusPocus and Yjs. We thank the contributors of all these projects for their awesome work!
We are proud sponsors of BlockNotejs and Yjs.
Docs is the result of a joint effort led by the French 🇫🇷🥖 (DINUM) and German 🇩🇪🥨 governments (ZenDiS).
We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱🧀), so feel free to reach out if you are interested in using or contributing to Docs.
