mirror of
https://github.com/suitenumerique/docs
synced 2026-04-21 21:47:35 +00:00
d1a3519646
## Purpose This pull request improves the project’s documentation entry points and overall readability to make Docs more approachable for new users and contributors. While reviewing the repository, I noticed that the project highlights documentation and Markdown support, but the front-page README contained several Markdown syntax issues and inconsistencies. This made the landing experience feel less polished than the quality of the project itself. The goal of this change is to provide a cleaner, more consistent, and more professional first impression. Please let me know and I can apply any changes, or edit other .md files as needed! ## Proposal - Rewrite the root README to be tighter, easier to scan, and more user-facing - Add a documentation landing page at `/docs/README.md` with a structured table of contents - Introduce `docs/instances.md` to list public Docs instances ## External contributions Thank you for your contribution! 🎉 Please ensure the following items are checked before submitting your pull request: - [x] I have read and followed the [contributing guidelines](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md) - [x] I have read and agreed to the [Code of Conduct](https://github.com/suitenumerique/docs/blob/main/CODE_OF_CONDUCT.md) - [x] I have signed off my commits with `git commit --signoff` (DCO compliance) - [x] I have signed my commits with my SSH or GPG key (`git commit -S`) - [x] My commit messages follow the required format: `<gitmoji>(type) title description` - [x] I have added a changelog entry under `## [Unreleased]` section - [x] I have not added tests because this PR only contains documentation changes --------- Signed-off-by: actuallypav <61046893+actuallypav@users.noreply.github.com>
240 lines
6.1 KiB
Markdown
240 lines
6.1 KiB
Markdown
<p align="center">
|
|
<a href="https://github.com/suitenumerique/docs">
|
|
<img alt="Docs" src="/docs/assets/banner-docs.png" width="100%" />
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/suitenumerique/docs/stargazers/">
|
|
<img src="https://img.shields.io/github/stars/suitenumerique/docs" alt="">
|
|
</a>
|
|
<a href="https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md">
|
|
<img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"/>
|
|
</a>
|
|
<a href="https://github.com/suitenumerique/docs/blob/main/LICENSE">
|
|
<img alt="MIT License" src="https://img.shields.io/github/license/suitenumerique/docs"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://matrix.to/#/#docs-official:matrix.org">Chat on Matrix</a> •
|
|
<a href="/docs/">Documentation</a> •
|
|
<a href="#try-docs">Try Docs</a> •
|
|
<a href="mailto:docs@numerique.gouv.fr">Contact us</a>
|
|
</p>
|
|
|
|
# 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.
|
|
|
|
|
|
|
|
|
|
## What is Docs?
|
|
|
|
Docs is an open-source alternative to tools like Notion or Google Docs, focused on:
|
|
|
|
- Real-time collaboration
|
|
- Clean, structured documents
|
|
- Knowledge organization
|
|
- Data ownership & self-hosting
|
|
|
|
***Built for public organizations, companies, and open communities.***
|
|
|
|
## Why use Docs?
|
|
|
|
### Writing
|
|
|
|
- Rich-text & Markdown editing
|
|
- Slash commands & block system
|
|
- Beautiful formatting
|
|
- Offline editing
|
|
- Optional AI writing helpers (rewirite, summarize, translate, fix typos)
|
|
|
|
### Collaboration
|
|
|
|
- Live cursors & presence
|
|
- Comments & sharing
|
|
- Granular access control
|
|
|
|
### Knowledge management
|
|
|
|
- Subpages & hierarchy
|
|
- Searchable content
|
|
|
|
### Export/Import & interoperability
|
|
|
|
- Import to `.docx` and `.md`
|
|
- Export to `.docx`, `.odt`, `.pdf`
|
|
|
|
## Try Docs
|
|
|
|
Experience Docs instantly - no installation required.
|
|
|
|
- 🔗 [Open a live demo document][demo]
|
|
- 🌍 [Browse public instances][instances]
|
|
|
|
[demo]: https://docs.la-suite.eu/docs/9137bbb5-3e8a-4ff7-8a36-fcc4e8bd57f4/
|
|
[instances]: /docs/instances.md
|
|
|
|
## Self-hosting
|
|
|
|
Docs supports Kubernetes, Docker Compose, and community-provided methods such as Nix and YunoHost.
|
|
|
|
Get started with self-hosting: [Installation guide](/docs/installation/README.md)
|
|
|
|
> [!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:
|
|
>
|
|
> ```bash
|
|
> PUBLISH_AS_MIT=true
|
|
> ```
|
|
>
|
|
> This builds an image of Docs without non-MIT features.
|
|
>
|
|
> More details can be found in [environment variables](/docs/env.md)
|
|
|
|
## 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
|
|
|
|
- Docker
|
|
- Docker Compose
|
|
- GNU Make
|
|
|
|
Verify installation:
|
|
|
|
```bash
|
|
docker -v
|
|
docker compose version
|
|
```
|
|
|
|
> If you encounounter 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:
|
|
|
|
```bash
|
|
make bootstrap FLUSH_ARGS='--no-input'
|
|
```
|
|
|
|
This builds the `app-dev` and `fronted-dev` containers, installs dependencies, runs database migrations, and compiles translations.
|
|
|
|
It is recommend to run this command after pulling new code.
|
|
|
|
Start services:
|
|
|
|
```bash
|
|
make run
|
|
```
|
|
|
|
Open <https://localhost:3000>
|
|
|
|
Default credentials (development only):
|
|
|
|
```md
|
|
username: impress
|
|
password: impress
|
|
```
|
|
|
|
### Frontend development mode
|
|
|
|
For frontend work, running outside Docker is often more convenient:
|
|
|
|
```bash
|
|
make frontend-development-install
|
|
make run-frontend-development
|
|
```
|
|
|
|
### Backend only
|
|
|
|
Starting all services except the frontend container:
|
|
|
|
```bash
|
|
make run-backend
|
|
```
|
|
|
|
### Tests & Linting
|
|
|
|
```bash
|
|
make frontend-test
|
|
make frontend-lint
|
|
```
|
|
|
|
### Demo content
|
|
|
|
Create a basic demo site:
|
|
|
|
```bash
|
|
make demo
|
|
```
|
|
|
|
### More Make targets
|
|
|
|
To check all available Make rules:
|
|
|
|
```bash
|
|
make help
|
|
```
|
|
|
|
### Django admin
|
|
|
|
Create a superuser:
|
|
|
|
```bash
|
|
make superuser
|
|
```
|
|
|
|
Admin UI: <http://localhost:8071/admin>
|
|
|
|
## Contributing
|
|
|
|
This project is community-driven and PRs are welcome.
|
|
|
|
- [Contribution guide](CONTRIBUTING.md)
|
|
- [Translations](https://crowdin.com/project/lasuite-docs)
|
|
- [Chat with us!](https://matrix.to/#/#docs-official:matrix.org)
|
|
|
|
## Roadmap
|
|
|
|
Curious where Docs is headed?
|
|
|
|
Explore upcoming features, priorities and long-term direction on our [public roadmap](https://docs.numerique.gouv.fr/docs/d1d3788e-c619-41ff-abe8-2d079da2f084/).
|
|
|
|
## License 📝
|
|
|
|
This work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/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](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [ProseMirror](https://prosemirror.net/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction), and [Yjs](https://yjs.dev/). We thank the contributors of all these projects for their awesome work!
|
|
|
|
We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).
|
|
|
|
---
|
|
|
|
### Gov ❤️ open source
|
|
|
|
Docs is the result of a joint initiative led by the French 🇫🇷 ([DINUM](https://www.numerique.gouv.fr/dinum/)) Government and German 🇩🇪 government ([ZenDiS](https://zendis.de/)).
|
|
|
|
We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱), feel free to [contact us](mailto:docs@numerique.gouv.fr) if you are interested in using or contributing to Docs.
|
|
|
|
<p align="center">
|
|
<img src="/docs/assets/europe_opensource.png" width="50%"/ alt="Europe Opensource">
|
|
</p>
|