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
这是什么?Docs 是一个开源的协作文本编辑器——可以自托管的 Notion 或 Google Docs 替代品,基于 Django 和 React 构建。团队可以在其中实时共同撰写、整理和分享文档。
它是像 Notion 那样的托管服务,还是需要我在自己的服务器上运行?两种方式都有:公共实例和在线演示让你无需安装即可试用,但这个项目本身就是为自托管设计的,这样你可以完全掌握自己的数据。
我怎么自己部署它?可以通过 Docker Compose 或 Kubernetes 按照安装指南部署,也有 Nix 和 YunoHost 等社区提供的方式。开发环境则用 Docker、Docker Compose 和 GNU Make 一键搭建整套服务。
运行它的机器需要什么条件?需要 Docker、Docker Compose 和 GNU Make。开发环境使用 Minio 作为兼容 S3 的存储后端,任何兼容 S3 的服务都可以替代它。
它的许可证是完全开源的吗,有没有什么限制?核心部分采用 MIT 许可证,但“导出为 PDF”和部分高级功能依赖 BlockNote XL 软件包,这些包采用 GPL 许可证,与 MIT 不兼容。你可以在构建镜像时不包含这些包,从而保持完全的 MIT 许可。
Docs 是为谁打造的?根据 README,它面向公共机构、公司和开放社区。它是法国公共部门软件套件 La Suite 的一部分,仓库也带有政府(government)和政府间(g2g)主题标签——但并没有任何限制规定它只能用于政府场景。
BlockNote 是什么?它是 Docs 所基于的开源 React 区块编辑器——仓库的话题标签里甚至列有 blocknotejs。Docs 在编辑器中使用了它的区块系统,BlockNote 的 AI 集成也为 V2 测试版的工具栏和光标提供支持。
这个项目成熟度如何?虽然年轻但已被广泛采用:仓库于 2024 年 1 月创建,在 GitHub 上约有 16900 颗星。Docker 镜像的发布已在 CI 中自动化,项目仍在积极开发中——并未归档。
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