{"id":26472427,"url":"https://github.com/suitenumerique/docs","last_synced_at":"2026-04-02T18:34:27.024Z","repository":{"id":216324709,"uuid":"741012134","full_name":"suitenumerique/docs","owner":"suitenumerique","description":"A collaborative note taking, wiki and documentation platform that scales. Built with Django and React. ","archived":false,"fork":false,"pushed_at":"2026-04-01T10:34:27.000Z","size":141656,"stargazers_count":16323,"open_issues_count":360,"forks_count":570,"subscribers_count":60,"default_branch":"main","last_synced_at":"2026-04-01T11:41:08.880Z","etag":null,"topics":["blocknotejs","collaborative","django","documentation","g2g","government","knowledge","knowledge-base","mit","mit-license","opensource","reactjs","realtime-collaboration","self-hosted","wiki","yjs"],"latest_commit_sha":null,"homepage":"https://docs.la-suite.eu/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suitenumerique.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":"publiccode.yml","codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-01-09T14:17:32.000Z","updated_at":"2026-04-01T07:05:52.000Z","dependencies_parsed_at":"2024-01-09T16:52:06.642Z","dependency_job_id":"3a92b21a-e720-4992-97c2-bc3654b75d68","html_url":"https://github.com/suitenumerique/docs","commit_stats":null,"previous_names":["numerique-gouv/impress","suitenumerique/docs"],"tags_count":118,"template":false,"template_full_name":null,"purl":"pkg:github/suitenumerique/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suitenumerique%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suitenumerique%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suitenumerique%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suitenumerique%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suitenumerique","download_url":"https://codeload.github.com/suitenumerique/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suitenumerique%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31307570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blocknotejs","collaborative","django","documentation","g2g","government","knowledge","knowledge-base","mit","mit-license","opensource","reactjs","realtime-collaboration","self-hosted","wiki","yjs"],"created_at":"2025-03-19T21:01:18.869Z","updated_at":"2026-04-02T18:34:27.016Z","avatar_url":"https://github.com/suitenumerique.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/suitenumerique/docs\"\u003e\n    \u003cimg alt=\"Docs\" src=\"/docs/assets/banner-docs.png\" width=\"100%\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/suitenumerique/docs/stargazers/\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/suitenumerique/docs\" alt=\"\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md\"\u003e\n    \u003cimg alt=\"PRs Welcome\" src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/suitenumerique/docs/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"MIT License\" src=\"https://img.shields.io/github/license/suitenumerique/docs\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://matrix.to/#/#docs-official:matrix.org\"\u003eChat on Matrix\u003c/a\u003e •\n  \u003ca href=\"/docs/\"\u003eDocumentation\u003c/a\u003e •\n  \u003ca href=\"#try-docs\"\u003eTry Docs\u003c/a\u003e •\n  \u003ca href=\"mailto:docs@numerique.gouv.fr\"\u003eContact us\u003c/a\u003e\n\u003c/p\u003e\n\n# La Suite Docs: Collaborative Text Editing\n\n**Docs, where your notes can become knowledge through live collaboration.**\n\nDocs is an open-source collaborative editor that helps teams write, organize, and share knowledge together - in real time.\n\n![Live collaboration demo](/docs/assets/docs_live_collaboration_light.gif)\n\n\n## What is Docs?\n\nDocs is an open-source alternative to tools like Notion or Google Docs, focused on:\n\n- Real-time collaboration\n- Clean, structured documents\n- Knowledge organization\n- Data ownership \u0026 self-hosting\n\n***Built for public organizations, companies, and open communities.***\n\n## Why use Docs?\n\n### Writing\n\n- Rich-text \u0026 Markdown editing\n- Slash commands \u0026 block system\n- Beautiful formatting\n- Offline editing\n- Optional AI writing helpers (rewrite, summarize, translate, fix typos)\n\n### Collaboration\n\n- Live cursors \u0026 presence\n- Comments \u0026 sharing\n- Granular access control\n\n### Knowledge management\n\n- Subpages \u0026 hierarchy\n- Searchable content\n\n### Export/Import \u0026 interoperability\n\n- Import to `.docx` and `.md`\n- Export to `.docx`, `.odt`, `.pdf`\n\n## Try Docs\n\nExperience Docs instantly - no installation required.\n\n- 🔗 [Open a live demo document][demo]\n- 🌍 [Browse public instances][instances]\n\n[demo]: https://docs.la-suite.eu/docs/9137bbb5-3e8a-4ff7-8a36-fcc4e8bd57f4/\n[instances]: /docs/instances.md\n\n## Self-hosting\n\nDocs supports Kubernetes, Docker Compose, and community-provided methods such as Nix and YunoHost.\n\nGet started with self-hosting: [Installation guide](/docs/installation/README.md)\n\n\u003e [!WARNING]\n\u003e Some advanced features (for example: `Export as PDF`) rely on XL packages from Blocknote.\n\u003e These packages are licensed under GPL and are **not MIT-compatible**\n\u003e\n\u003e You can run Docs **without these packages** by building with:\n\u003e\n\u003e ```bash\n\u003e PUBLISH_AS_MIT=true\n\u003e ```\n\u003e\n\u003e This builds an image of Docs without non-MIT features.\n\u003e\n\u003e More details can be found in [environment variables](/docs/env.md)\n\n## Local Development (for contributors)\n\nRun Docs locally for development and testing.\n\n\u003e [!WARNING]\n\u003e This setup is intended **for development and testing only**.\n\u003e It uses Minio as an S3-compatible storage backend, but any S3-compatible service can be used.\n\n### Prerequisites\n\n- Docker\n- Docker Compose\n- GNU Make\n\nVerify installation:\n\n```bash\ndocker -v\ndocker compose version\n```\n\n\u003e If you encounter permission errors, you may need to use `sudo`, or add your user to the `docker` group.\n\n### Bootstrap the project\n\nThe easiest way to start is using GNU Make:\n\n```bash\nmake bootstrap FLUSH_ARGS='--no-input'\n```\n\nThis builds the `app-dev` and `frontend-dev` containers, installs dependencies, runs database migrations, and compiles translations.\n\nIt is recommended to run this command after pulling new code.\n\nStart services:\n\n```bash\nmake run\n```\n\nOpen \u003chttps://localhost:3000\u003e\n\nDefault credentials (development only):\n\n```md\nusername: impress\npassword: impress\n```\n\n### Frontend development mode\n\nFor frontend work, running outside Docker is often more convenient:\n\n```bash\nmake frontend-development-install\nmake run-frontend-development\n```\n\n### Backend only\n\nStarting all services except the frontend container:\n\n```bash\nmake run-backend\n```\n\n### Tests \u0026 Linting\n\n```bash\nmake frontend-test\nmake frontend-lint\n```\n\nBackend tests can be run without docker. This is useful to configure PyCharm or VSCode to do it. \nRemoving docker for testing requires to overwrite some URL and port values that are different in and out of \nDocker. `env.d/development/common` contains all variables, some of them having to be overwritten by those in\n`env.d/development/common.test`.\n\n### Demo content\n\nCreate a basic demo site:\n\n```bash\nmake demo\n```\n\n### More Make targets\n\nTo check all available Make rules:\n\n```bash\nmake help\n```\n\n### Django admin\n\nCreate a superuser:\n\n```bash\nmake superuser\n```\n\nAdmin UI: \u003chttp://localhost:8071/admin\u003e\n\n## Contributing\n\nThis project is community-driven and PRs are welcome.\n\n- [Contribution guide](CONTRIBUTING.md)\n- [Translations](https://crowdin.com/project/lasuite-docs)\n- [Chat with us!](https://matrix.to/#/#docs-official:matrix.org)\n\n## Roadmap\n\nCurious where Docs is headed?\n\nExplore upcoming features, priorities and long-term direction on our [public roadmap](https://docs.numerique.gouv.fr/docs/d1d3788e-c619-41ff-abe8-2d079da2f084/).\n\n## License 📝\n\nThis work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/LICENSE)).\n\nWhile Docs is a public-driven initiative, our license choice is an invitation for private sector actors to use, sell and contribute to the project.\n\n## Credits ❤️\n\n### Stack\n\nDocs 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!\n\nWe are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/).\n\n---\n\n### Gov ❤️ open source\n\nDocs 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/)).\n\nWe 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.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"/docs/assets/europe_opensource.png\" width=\"50%\"/ alt=\"Europe Opensource\"\u003e\n\u003c/p\u003e\n","funding_links":[],"categories":["Python","知识管理_wiki知识库","django","Repos","self-hosted","Projects Using BlockNote"],"sub_categories":["资源传输下载","Open source projects"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuitenumerique%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuitenumerique%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuitenumerique%2Fdocs/lists"}