# Docs by Suite Numerique — Collaborative Wiki and Documentation Platform

> Docs is an open-source, self-hosted collaborative documentation platform built with Django and React, featuring real-time co-editing and markdown support for teams and government organizations.

## Install

Save in your project root:

# Docs by Suite Numerique — Collaborative Wiki and Documentation Platform

## Quick Use
```bash
git clone https://github.com/suitenumerique/docs.git
cd docs
make setup
make run
```

## Introduction
Docs is an open-source collaborative documentation and wiki platform developed by La Suite Numerique, a French government digital initiative. Built with Django on the backend and React with BlockNote on the frontend, it provides real-time collaborative editing for teams that need full control over their documentation infrastructure.

## What Docs Does
- Enables real-time collaborative document editing with multiple simultaneous users
- Provides a block-based editor powered by BlockNote.js for rich content creation
- Supports markdown-native workflows with export and import capabilities
- Offers fine-grained access control and sharing permissions per document
- Syncs changes in real time using Yjs CRDT for conflict-free concurrent editing

## Architecture Overview
The backend runs on Django with a PostgreSQL database for document storage and metadata. Real-time collaboration is handled through Yjs, a CRDT framework that enables conflict-free concurrent editing without a central server arbitrating changes. The frontend is a React application using BlockNote.js as the rich text editor. WebSocket connections maintain live sync between collaborators.

## Self-Hosting & Configuration
- Deploy using Docker Compose with the provided configuration files
- Set up PostgreSQL as the primary data store
- Configure environment variables for authentication and email settings
- Use the included Makefile for development setup and database migrations
- Optionally configure SSO via OpenID Connect for enterprise authentication

## Key Features
- Real-time collaborative editing with conflict-free resolution via Yjs
- Block-based editor supporting text, headings, lists, tables, and embeds
- Document versioning with history and rollback capabilities
- Multi-tenant architecture suitable for organizations with multiple teams
- MIT-licensed and backed by a government-funded open-source initiative

## Comparison with Similar Tools
- **Outline** — similar wiki focus but Docs uses BlockNote and Yjs for editing
- **BookStack** — chapter-based organization; Docs offers free-form document editing
- **Wiki.js** — more wiki-oriented with page trees; Docs emphasizes real-time co-editing
- **HedgeDoc** — markdown-only; Docs provides a richer block-based editing experience
- **Notion** — proprietary SaaS; Docs is fully self-hosted and open source

## FAQ
**Q: What database does Docs require?**
A: PostgreSQL is the primary supported database.

**Q: Can I integrate Docs with my existing SSO provider?**
A: Yes. Docs supports OpenID Connect for single sign-on integration.

**Q: Is Docs production-ready?**
A: It is actively used in French government infrastructure and receives regular updates.

**Q: What languages are supported in the interface?**
A: The interface supports multiple languages through Django's internationalization framework.

## Sources
- https://github.com/suitenumerique/docs
- https://lasuite.numerique.gouv.fr

---
Source: https://tokrepo.com/en/workflows/asset-96e89e7b
Author: AI Open Source