Skip to content

Commit fd01eb8

Browse files
committed
📝(readme) update xl packages info
AGPL XL packages from BlockNote will no longer be install by default Signed-off-by: virgile-deville <[email protected]>
1 parent ecd0656 commit fd01eb8

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,29 @@ Welcome to Docs! The open source document editor where your notes can become kno
2424

2525
## Why use Docs ❓
2626

27-
⚠️ **Note that Docs provides docs/pdf exporters by loading [two BlockNote packages](https://github.com/suitenumerique/docs/blob/main/src/frontend/apps/impress/package.json#L22C7-L23C53), which we use under the AGPL-3.0 licence. Until we comply with the terms of this license, we recommend that you don't run Docs as a commercial product, unless you are willing to sponsor [BlockNote](https://github.com/TypeCellOS/BlockNote).**
28-
2927
Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
3028

3129
### Write
30+
3231
* 😌 Simple collaborative editing without the formatting complexity of markdown
3332
* 🔌 Offline? No problem, keep writing, your edits will get synced when back online
3433
* 💅 Create clean documents with limited but beautiful formatting options and focus on content
3534
* 🧱 Built for productivity (markdown support, many block types, slash commands, keyboard shortcuts).
3635
* ✨ Save time thanks to our AI actions (generate, sum up, correct, translate)
3736

3837
### Collaborate
38+
3939
* 🤝 Collaborate with your team in real time
4040
* 🔒 Granular access control to ensure your information is secure and only shared with the right people
4141
* 📑 Professional document exports in multiple formats (.odt, .doc, .pdf) with customizable templates
4242
* 📚 Built-in wiki functionality to turn your team's collaborative work into organized knowledge `ETA 02/2025`
4343

4444
### Self-host
45+
4546
* 🚀 Easy to install, scalable and secure alternative to Notion, Outline or Confluence
4647

48+
⚠️ During Docs installation, you will be prompted if you want to install them or not. Please ensure to fulfill your obligation regarding BlockNoteJS licensing (see https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE and https://www.blocknotejs.org/about#partner-with-us). Note that Docs works perfectly fine without these export features.
49+
4750
## Getting started 🔧
4851

4952
### Test it
@@ -118,6 +121,7 @@ $ make run-backend
118121
```
119122

120123
**Adding content**
124+
121125
You can create a basic demo site by running:
122126

123127
```shellscript

0 commit comments

Comments
 (0)