Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

cpretzer/docs

Repository files navigation

Welcome to Docs! The open source document editor where your notes can become knowledge through live collaboration

Chat on Matrix - Documentation - Getting started - Reach out

Why use Docs

Note that Docs provides docs/pdf exporters by loading two BlockNote packages, which we use under the AGPL-3.0 licence. Until we comply with the terms of this license, we recommend that you don't run Docs as a commercial product, unless you are willing to sponsor BlockNote.

Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.

Write

  • Simple collaborative editing without the formatting complexity of markdown
  • Offline? No problem, keep writing, your edits will get synced when back online
  • Create clean documents with limited but beautiful formatting options and focus on content
  • Built for productivity (markdown support, many block types, slash commands, keyboard shortcuts).
  • Save time thanks to our AI actions (generate, sum up, correct, translate)

Collaborate

  • Collaborate with your team in real time
  • Granular access control to ensure your information is secure and only shared with the right people
  • Professional document exports in multiple formats (.odt, .doc, .pdf) with customizable templates
  • Built-in wiki functionality to turn your team's collaborative work into organized knowledge ETA 02/2025

Self-host

  • Easy to install, scalable and secure alternative to Notion, Outline or Confluence

Getting started

Test it

Test Docs on your browser by logging in on this environment

email: test.docs@yopmail.com
password: I'd<3ToTestDocs

Run it locally

Running Docs locally using the methods described below is for testing purposes only. It is based on building Docs using Minio as the S3 storage solution but you can choose any S3 compatible object storage of your choice.

Prerequisite

Make sure you have a recent version of Docker and Docker Compose installed on your laptop:

$ 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 with sudo but this can be avoided by adding your user to the docker group.

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 compile 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 to 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

For the frontend developer, it is often better to run the frontend in development mode locally.

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:

$ make demo

Finally, you can check all available Make rules using:

$ make help

Django admin

You can access the Django admin site at

http://localhost:8071/admin.

You first need to create a superuser account:

$ make superuser

Feedback

We'd love to hear your thoughts and hear about your experiments, so come and say hi on Matrix.

Roadmap

Want to know where the project is headed? Checkout our roadmap

Licence

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.

Contributing

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.

Directory structure:

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.

Credits

Stack

Docs is built on top of Django Rest Framework, Next.js, BlockNote.js, HocusPocus and Yjs.

Gov open source

Docs is the result of a joint effort led by the French (DINUM) and German governments (ZenDiS).

We are proud sponsors of BlockNotejs and Yjs.

We are always looking for new public partners (we are currently onboarding the Netherlands ), feel free to reach out if you are interested in using or contributing to Docs.

About

A collaborative note taking, wiki and documentation platform that scales. Built with Django and React. Opensource alternative to Notion or Outline.

Resources

Readme

License

MIT license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors

Languages

  • Python 57.3%
  • TypeScript 36.1%
  • CSS 3.5%
  • JavaScript 0.8%
  • Shell 0.7%
  • Makefile 0.7%
  • Other 0.9%