|
|
|
@@ -3,226 +3,238 @@
|
|
|
|
|
<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?style=shields'/></a>
|
|
|
|
|
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/suitenumerique/docs"/>
|
|
|
|
|
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/suitenumerique/docs"/>
|
|
|
|
|
<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="#getting-started-">
|
|
|
|
|
Getting started
|
|
|
|
|
</a> - <a href="mailto:docs@numerique.gouv.fr">
|
|
|
|
|
Reach out
|
|
|
|
|
</a>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
# La Suite Docs : Collaborative Text Editing
|
|
|
|
|
Docs, where your notes can become knowledge through live collaboration.
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
<img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
|
|
|
|
|
# La Suite Docs: Collaborative Text Editing
|
|
|
|
|
|
|
|
|
|
## Why use Docs ❓
|
|
|
|
|
Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
|
|
|
|
|
**Docs, where your notes can become knowledge through live collaboration.**
|
|
|
|
|
|
|
|
|
|
### Write
|
|
|
|
|
* 😌 Get simple, accessible online editing for your team.
|
|
|
|
|
* 💅 Create clean documents with beautiful formatting options.
|
|
|
|
|
* 🖌️ Focus on your content using either the in-line editor, or [the Markdown syntax](https://www.markdownguide.org/basic-syntax/).
|
|
|
|
|
* 🧱 Quickly design your page thanks to the many block types, accessible from the `/` slash commands, as well as keyboard shortcuts.
|
|
|
|
|
* 🔌 Write offline! Your edits will be synced once you're back online.
|
|
|
|
|
* ✨ Save time thanks to our AI actions, such as rephrasing, summarizing, fixing typos, translating, etc. You can even turn your selected text into a prompt!
|
|
|
|
|
Docs is an open-source collaborative editor that helps teams write, organize, and share knowledge together - in real time.
|
|
|
|
|
|
|
|
|
|
### Work together
|
|
|
|
|
* 🤝 Enjoy live editing! See your team collaborate in real time.
|
|
|
|
|
* 🔒 Keep your information secure thanks to granular access control. Only share with the right people.
|
|
|
|
|
* 📑 Export your content in multiple formats (`.odt`, `.docx`, `.pdf`) with customizable templates.
|
|
|
|
|
* 📚 Turn your team's collaborative work into organized knowledge with Subpages.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Self-host
|
|
|
|
|
|
|
|
|
|
#### 🚀 Docs is easy to install on your own servers
|
|
|
|
|
We use Kubernetes for our [production instance](https://docs.numerique.gouv.fr/) but also support Docker Compose. The community contributed a couple other methods (Nix, YunoHost etc.) check out the [docs](/docs/installation/README.md) to get detailed instructions and examples.
|
|
|
|
|
## What is Docs?
|
|
|
|
|
|
|
|
|
|
#### 🌍 Known instances
|
|
|
|
|
We hope to see many more, here is an incomplete list of public Docs instances. Feel free to make a PR to add ones that are not listed below🙏
|
|
|
|
|
Docs is an open-source alternative to tools like Notion or Google Docs, focused on:
|
|
|
|
|
|
|
|
|
|
| Url | Org | Public |
|
|
|
|
|
| --- | --- | ------- |
|
|
|
|
|
| [docs.numerique.gouv.fr](https://docs.numerique.gouv.fr/) | DINUM | French public agents working for the central administration and the extended public sphere. ProConnect is required to login in or sign up|
|
|
|
|
|
| [docs.suite.anct.gouv.fr](https://docs.suite.anct.gouv.fr/) | ANCT | French public agents working for the territorial administration and the extended public sphere. ProConnect is required to login in or sign up|
|
|
|
|
|
| [notes.demo.opendesk.eu](https://notes.demo.opendesk.eu) | ZenDiS | Demo instance of OpenDesk. Request access to get credentials |
|
|
|
|
|
| [notes.liiib.re](https://notes.liiib.re/) | lasuite.coop | Free and open demo to all. Content and accounts are reset after one month |
|
|
|
|
|
| [docs.federated.nexus](https://docs.federated.nexus/) | federated.nexus | Public instance, but you have to [sign up for a Federated Nexus account](https://federated.nexus/register/). |
|
|
|
|
|
| [docs.demo.mosacloud.eu](https://docs.demo.mosacloud.eu/) | mosa.cloud | Demo instance of mosa.cloud, a dutch company providing services around La Suite apps. |
|
|
|
|
|
- Real-time collaboration
|
|
|
|
|
- Clean, structured documents
|
|
|
|
|
- Knowledge organization
|
|
|
|
|
- Data ownership & self-hosting
|
|
|
|
|
|
|
|
|
|
#### ⚠️ Advanced features
|
|
|
|
|
For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under GPL and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/env.md) for more information.
|
|
|
|
|
***Built for public organizations, companies, and open communities.***
|
|
|
|
|
|
|
|
|
|
## Getting started 🔧
|
|
|
|
|
## Why use Docs?
|
|
|
|
|
|
|
|
|
|
### Test it
|
|
|
|
|
### Writing
|
|
|
|
|
|
|
|
|
|
You can test Docs on your browser by visiting this [demo document](https://docs.la-suite.eu/docs/9137bbb5-3e8a-4ff7-8a36-fcc4e8bd57f4/)
|
|
|
|
|
- Rich-text & Markdown editing
|
|
|
|
|
- Slash commands & block system
|
|
|
|
|
- Beautiful formatting
|
|
|
|
|
- Offline editing
|
|
|
|
|
- Optional AI writing helpers (rewirite, summarize, translate, fix typos)
|
|
|
|
|
|
|
|
|
|
### Run Docs locally
|
|
|
|
|
### Collaboration
|
|
|
|
|
|
|
|
|
|
> ⚠️ The methods described below for running Docs locally is **for testing purposes only**. It is based on building Docs using [Minio](https://min.io/) as an S3-compatible storage solution. Of course you can choose any S3-compatible storage solution.
|
|
|
|
|
- Live cursors & presence
|
|
|
|
|
- Comments & sharing
|
|
|
|
|
- Granular access control
|
|
|
|
|
|
|
|
|
|
**Prerequisite**
|
|
|
|
|
### Knowledge management
|
|
|
|
|
|
|
|
|
|
Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop, then type:
|
|
|
|
|
- Subpages & hierarchy
|
|
|
|
|
- Searchable content
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ docker -v
|
|
|
|
|
### Export/Import & interoperability
|
|
|
|
|
|
|
|
|
|
Docker version 20.10.2, build 2291f61
|
|
|
|
|
- Import to `.docx` and `.md`
|
|
|
|
|
- Export to `.docx`, `.odt`, `.pdf`
|
|
|
|
|
|
|
|
|
|
$ docker compose version
|
|
|
|
|
## Try Docs
|
|
|
|
|
|
|
|
|
|
Docker Compose version v2.32.4
|
|
|
|
|
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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
> ⚠️ You may need to run the following commands with `sudo`, but this can be avoided by adding your user to the local `docker` group.
|
|
|
|
|
> If you encounounter permission errors, you may need to use `sudo`, or add your user to the `docker` group.
|
|
|
|
|
|
|
|
|
|
**Project bootstrap**
|
|
|
|
|
### Bootstrap the project
|
|
|
|
|
|
|
|
|
|
The easiest way to start working on the project is to use [GNU Make](https://www.gnu.org/software/make/):
|
|
|
|
|
The easiest way to start is using GNU Make:
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make bootstrap FLUSH_ARGS='--no-input'
|
|
|
|
|
```bash
|
|
|
|
|
make bootstrap FLUSH_ARGS='--no-input'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This command builds the `app-dev` and `frontend-dev` containers, installs dependencies, performs database migrations and compiles 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.
|
|
|
|
|
This builds the `app-dev` and `fronted-dev` containers, installs dependencies, runs database migrations, and compiles translations.
|
|
|
|
|
|
|
|
|
|
Your Docker services should now be up and running 🎉
|
|
|
|
|
It is recommend to run this command after pulling new code.
|
|
|
|
|
|
|
|
|
|
You can access the project by going to <http://localhost:3000>.
|
|
|
|
|
|
|
|
|
|
You will be prompted to log in. The default credentials are:
|
|
|
|
|
Start services:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make run
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Open <https://localhost:3000>
|
|
|
|
|
|
|
|
|
|
Default credentials (development only):
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
username: impress
|
|
|
|
|
password: impress
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
📝 Note that if you need to run them afterwards, you can use the eponymous Make rule:
|
|
|
|
|
### Frontend development mode
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make run
|
|
|
|
|
For frontend work, running outside Docker is often more convenient:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make frontend-development-install
|
|
|
|
|
make run-frontend-development
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
⚠️ For the frontend developer, it is often better to run the frontend in development mode locally.
|
|
|
|
|
### Backend only
|
|
|
|
|
|
|
|
|
|
To do so, install the frontend dependencies with the following command:
|
|
|
|
|
Starting all services except the frontend container:
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make frontend-development-install
|
|
|
|
|
```bash
|
|
|
|
|
make run-backend
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
And run the frontend locally in development mode with the following command:
|
|
|
|
|
### Tests & Linting
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make run-frontend-development
|
|
|
|
|
```bash
|
|
|
|
|
make frontend-test
|
|
|
|
|
make frontend-lint
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To start all the services, except the frontend container, you can use the following command:
|
|
|
|
|
### Demo content
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make run-backend
|
|
|
|
|
Create a basic demo site:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make demo
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To execute frontend tests & linting only
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make frontend-test
|
|
|
|
|
$ make frontend-lint
|
|
|
|
|
### More Make targets
|
|
|
|
|
|
|
|
|
|
To check all available Make rules:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make help
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**Adding content**
|
|
|
|
|
### Django admin
|
|
|
|
|
|
|
|
|
|
You can create a basic demo site by running this command:
|
|
|
|
|
Create a superuser:
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make demo
|
|
|
|
|
```bash
|
|
|
|
|
make superuser
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Finally, you can check all available Make rules using this command:
|
|
|
|
|
Admin UI: <http://localhost:8071/admin>
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make help
|
|
|
|
|
```
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
**Django admin**
|
|
|
|
|
This project is community-driven and PRs are welcome.
|
|
|
|
|
|
|
|
|
|
You can access the Django admin site at:
|
|
|
|
|
- [Contribution guide](CONTRIBUTING.md)
|
|
|
|
|
- [Translations](https://crowdin.com/project/lasuite-docs)
|
|
|
|
|
- [Chat with us!](https://matrix.to/#/#docs-official:matrix.org)
|
|
|
|
|
|
|
|
|
|
<http://localhost:8071/admin>.
|
|
|
|
|
## Roadmap
|
|
|
|
|
|
|
|
|
|
You first need to create a superuser account:
|
|
|
|
|
Curious where Docs is headed?
|
|
|
|
|
|
|
|
|
|
```shellscript
|
|
|
|
|
$ make superuser
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Feedback 🙋♂️🙋♀️
|
|
|
|
|
|
|
|
|
|
We'd love to hear your thoughts, and hear about your experiments, so come and say hi on [Matrix](https://matrix.to/#/#docs-official:matrix.org).
|
|
|
|
|
|
|
|
|
|
## Roadmap 💡
|
|
|
|
|
|
|
|
|
|
Want to know where the project is headed? [🗺️ Checkout our roadmap](https://github.com/orgs/numerique-gouv/projects/13/views/11)
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
## Contributing 🙌
|
|
|
|
|
|
|
|
|
|
This project is intended to be community-driven, so please, do not hesitate to [get in touch](https://matrix.to/#/#docs-official:matrix.org) if you have any question related to our implementation or design decisions.
|
|
|
|
|
|
|
|
|
|
You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
|
|
|
|
|
|
|
|
|
|
If you intend to make pull requests, see [CONTRIBUTING](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md) for guidelines.
|
|
|
|
|
|
|
|
|
|
## Directory structure:
|
|
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
|
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.
|
|
|
|
|
```
|
|
|
|
|
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/), [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!
|
|
|
|
|
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/).
|
|
|
|
|
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 effort led by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)).
|
|
|
|
|
|
|
|
|
|
We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱🧀), feel free to [reach out](mailto:[email protected]) if you are interested in using or contributing to Docs.
|
|
|
|
|
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:[email protected]) if you are interested in using or contributing to Docs.
|
|
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
<img src="/docs/assets/europe_opensource.png" width="50%"/>
|
|
|
|
|
<img src="/docs/assets/europe_opensource.png" width="50%"/ alt="Europe Opensource">
|
|
|
|
|
</p>
|
|
|
|
|
pav