docs README

The project's README from github.com/suitenumerique/docs. As one markdown file: README.md.

Docs

PRs Welcome MIT License MIT License DPG Badge

Chat on Matrix • Documentation • Try Docs • Contact us

La Suite Docs: Collaborative Text Editing

Docs, where your notes can become knowledge through live collaboration.

Docs is an open-source collaborative editor that helps teams write, organize, and share knowledge together - in real time.

Live collaboration demo

What is Docs?

Docs is an open-source alternative to tools like Notion or Google Docs, focused on:

Built for public organizations, companies, and open communities.

Why use Docs?

Writing

Collaboration

Knowledge management

Presentations

demo of slide mode in Docs

Export/Import

AI features

Docs has optional AI features. They're model agnostic and gateway agnostic. You can either run your own or just use your AI provider. The config only requires an API key and a URL.

V1: You select, AI replaces

This version features a simple select and replace workflow. Your selection is the context and the instruction for the model. The AI feedback replaces your selection and is designed is optimized for Docs formatting.

Demo of Docs AI v1

V2: AI toolbar, AI cursor (beta)

This version uses BlockNote AI integration. It features:

Demo of Docs AI v2

Interoperability

Docs comes with a resource server API and a server to server API which allows for awesome integrations.

A concrete example: Meet's transcriptions

If you're running a Meet instance, with simple config (DJANGO_SERVER_TO_SERVER_API_TOKENS) you can push your meeting transcript to Docs and give access to the user who requested it.

transcript in Docs screenshot

Try Docs

Experience Docs instantly - no installation required.

Self-hosting

Docs supports Kubernetes, Docker Compose, and community-provided methods such as Nix and YunoHost.

Get started with self-hosting: Installation guide

[!WARNING] Some advanced features (for example: Export as PDF) rely on XL packages from Blocknote. These packages are licensed under GPL and are not MIT-compatible

You can run Docs without these packages by building with:

PUBLISH_AS_MIT=true

This builds an image of Docs without non-MIT features.

More details can be found in environment variables

Local Development (for contributors)

Run Docs locally for development and testing.

[!WARNING] This setup is intended for development and testing only. It uses Minio as an S3-compatible storage backend, but any S3-compatible service can be used.

Prerequisites

Verify installation:

docker -v
docker compose version

If you encounter permission errors, you may need to use sudo, or add your user to the docker group.

Bootstrap the project

The easiest way to start is using GNU Make:

make bootstrap FLUSH_ARGS='--no-input'

This builds the app-dev and frontend-dev containers, installs dependencies, runs database migrations, and compiles translations.

It is recommended to run this command after pulling new code.

Start services:

make run

Open https://localhost:3000

Default credentials (development only):

username: impress
password: impress

Frontend development mode

For frontend work, running outside Docker is often more convenient:

make frontend-development-install
make run-frontend-development

Backend only

Starting all services except the frontend container:

make run-backend

Tests & Linting

make frontend-test
make frontend-lint

Backend tests can be run without docker. This is useful to configure PyCharm or VSCode to do it. Removing docker for testing requires to overwrite some URL and port values that are different in and out of Docker. env.d/development/common contains all variables, some of them having to be overwritten by those in env.d/development/common.test.

Demo content

Create a basic demo site:

make demo

More Make targets

To check all available Make rules:

make help

Django admin

Create a superuser:

make superuser

Admin UI: http://localhost:8071/admin

Contributing

This project is community-driven and PRs are welcome.

Roadmap

Curious where Docs is headed?

Explore upcoming features, priorities and long-term direction on our public roadmap.

License 📝

This work is released under the MIT License (see LICENSE).

While Docs is a public-driven initiative, our license choice is an invitation for private sector actors to use, sell and contribute to the project.

Credits ❤️

Stack

Docs is built on top of Django Rest Framework, Next.js, ProseMirror, 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.


Gov ❤️ open source

Docs is the result of a joint initiative led by the French 🇫🇷 (DINUM) Government and German 🇩🇪 government (ZenDiS).

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

Europe Opensource

docs (suitenumerique/docs)

Searching Database…

16.9K ·GitHub
What is this?Docs is an open-source collaborative text editor - a self-hostable alternative to Notion or Google Docs, built on Django and React. Teams write, organize and share documents together in real time.
Is this a hosted service like Notion, or do I run it on my own server?Both options exist: public instances and a live demo let you try it with no install, but the project is built for self-hosting so you keep full ownership of your data.
How do I self-host it?Docker Compose or Kubernetes via the installation guide, plus community methods like Nix and YunoHost. For development, Docker with Docker Compose and GNU Make bootstrap the whole stack.
What does the machine it runs on need?Docker, Docker Compose and GNU Make. The dev setup uses Minio as an S3-compatible storage backend, and any S3-compatible service works in its place.
Is the license fully open, or is there a catch?The core is MIT, but Export as PDF and some advanced features rely on BlockNote XL packages licensed under GPL, which is not MIT-compatible. You can build an image without those packages to stay fully MIT.
Who is Docs built for?Public organizations, companies and open communities, per the README. It ships as part of La Suite, a French public-sector software suite, and the repo carries government and g2g topics - but nothing limits it to government use.
What is BlockNote?The open-source React block editor Docs is built on - the repo even lists blocknotejs among its topics. Docs uses its block system in the editor, and BlockNote's AI integration powers the V2 beta toolbar and cursor.
How mature is the project?Young but widely adopted: the repository appeared in January 2024 and has about 16,900 GitHub stars. Docker image publishing is automated in CI, and the project is actively developed - not archived.
What are similar projects?docmost, oxynote, AFFiNE, outline, OpenLore, showdoc, TREK, open-knowledge
Size
159.6 MB
Stars
16.9K
Age
2y
Commits · 90 Days