Navigation Menu

切换导航 登录

搜索或跳转到...

搜索代码、仓库、用户、议题、Pull Request...

搜索 清除 搜索语法提示

提供反馈

我们会阅读每一条反馈，并非常认真地对待您的意见。 包括我的电子邮件地址，以便我可以被联系 取消 提交反馈

保存的搜索

使用保存的搜索更快地过滤结果

名称 查询 要查看所有可用的限定符，请参阅我们的文档。 取消 创建保存的搜索 登录 注册 重置焦点 您已在另一个选项卡或窗口中登录。重新加载以刷新您的会话。您已在另一个选项卡或窗口中注销。重新加载以刷新您的会话。您已在另一个选项卡或窗口中切换了帐户。重新加载以刷新您的会话。 关闭警报 {{ message }} suitenumerique / **docs ** 公开

一个可扩展的协作式笔记、wiki 和文档平台。使用 Django 和 React 构建。是 Notion 或 Outline 的开源替代方案。 docs.numerique.gouv.fr

许可证

MIT license 894 stars 28 forks Branches Tags Activity Star 通知 您必须登录才能更改通知设置

其他导航选项

suitenumerique/docs

main BranchesTags 前往文件 代码

文件夹和文件

名称| 名称| 最后提交消息| 最后提交日期 ---|---|---|---

最新提交

历史

897 Commits .github| .github bin| bin crowdin| crowdin docker| docker docs| docs env.d/development| env.d/development gitlint| gitlint src| src .dockerignore| .dockerignore .gitignore| .gitignore .gitlint| .gitlint .gitmodules| .gitmodules .sops.yaml| .sops.yaml CHANGELOG.md| CHANGELOG.md CODE_OF_CONDUCT.md| CODE_OF_CONDUCT.md CONTRIBUTING.md| CONTRIBUTING.md Dockerfile| Dockerfile LICENSE| LICENSE Makefile| Makefile README.md| README.md SECURITY.md| SECURITY.md UPGRADE.md| UPGRADE.md docker-compose.yml| docker-compose.yml renovate.json| renovate.json 查看所有文件

仓库文件导航

Docs 欢迎使用 Docs！这是一个开源文档编辑器，通过实时协作，您的笔记可以转化为知识 在 Matrix 上聊天 - 文档 - 开始使用 - 联系我们

为什么使用 Docs ❓

Docs 是一款协作文本编辑器，旨在解决知识构建和共享中的常见挑战。

编写

协作

自托管

开始使用 🔧

试用

在此环境上登录，在您的浏览器上测试 Docs

email: test.docs@yopmail.com
password: I'd<3ToTestDocs

在本地运行

⚠️ 使用下述方法在本地运行 Docs 仅用于测试目的。 它是基于使用 Minio 作为 S3 存储解决方案来构建 Docs 的：如果您想将 Minio 用于 Docs 的生产部署，您将需要遵守 Minio 的 AGPL-3.0 许可。 前提条件 确保您的笔记本电脑上安装了最新版本的 Docker 和 Docker Compose：

$ docker -v
Docker version 20.10.2, build 2291f61
$ docker compose version
Docker Compose version v2.32.4

⚠️ 您可能需要使用 sudo 运行以下命令，但可以通过将您的用户添加到 docker 组来避免这种情况。 项目引导 开始处理项目最简单的方法是使用 GNU Make：

$ make bootstrap FLUSH_ARGS='--no-input'

此命令构建 app 容器，安装依赖项，执行数据库迁移并编译翻译。 每次从项目存储库中提取代码时，最好都使用此命令，以避免与依赖项或迁移相关的问题。 您的 Docker 服务现在应该已经启动并运行 🎉 您可以通过访问 http://localhost:3000 访问该项目。 系统将提示您登录，默认凭据为：

username: impress
password: impress

📝 请注意，如果您需要在之后运行它们，可以使用同名的 Make 规则：

$ make run

⚠️ 对于前端开发者，通常最好在本地以开发模式运行前端。 为此，请使用以下命令安装前端依赖项：

$ make frontend-development-install

并使用以下命令在本地以开发模式运行前端：

$ make run-frontend-development

要启动除前端容器之外的所有服务，可以使用以下命令：

$ make run-backend

添加内容 您可以通过运行以下命令来创建基本的演示站点：

$ make demo

最后，您可以使用以下命令检查所有可用的 Make 规则：

$ make help

Django admin 您可以通过 http://localhost:8071/admin 访问 Django admin 站点。 您首先需要创建一个超级用户帐户：

$ make superuser

反馈 🙋‍♂️🙋‍♀️

我们很乐意听到您的想法和实验，所以请在 Matrix 上打个招呼。

路线图

想知道该项目的走向吗？ 🗺️ 查看我们的路线图

许可证 📝

这项工作已根据 MIT License 发布（请参阅 LICENSE)。 虽然 Docs 是一项公共驱动的倡议，但我们的许可证选择是邀请私营部门参与者使用、销售和贡献该项目。

贡献 🙌

该项目旨在由社区驱动，因此如果您有任何与我们的实施或设计决策相关的问题，请随时联系。 您可以在 Crowdin 上帮助我们进行翻译。 如果您打算提交 Pull Request，请参阅 CONTRIBUTING 获取指南。 目录结构：

docs
├── bin - 用于各种任务的可执行脚本或二进制文件，例如设置脚本、实用程序脚本或自定义命令。
├── crowdin - 用于 crowdin 翻译，一种帮助管理项目翻译的工具或服务。
├── docker - 用于构建项目 Docker 镜像的 Dockerfile 和相关配置文件。 这些镜像可用于开发、测试或生产环境。
├── docs - 项目的文档，包括用户指南、API 文档和其他有用的资源。
├── env.d/development - 开发环境的环境特定配置文件。 这些文件可能包括环境变量、配置设置或开发所需的其他设置文件。
├── gitlint - 用于 `gitlint` 的配置文件，`gitlint` 是一种强制执行提交消息准则的工具，以确保提交消息的一致性和质量。
├── playground - 实验性或临时代码，开发人员可以在其中测试新功能或想法，而不会影响主代码库。
└── src - 主要源代码目录，包含项目的核心应用程序代码、库和模块。

Credits ❤️

技术栈

Docs 构建于 Django Rest Framework, Next.js, BlockNote.js, HocusPocus 和 Yjs 之上。

Gov ❤️ 开源

Docs 是法国 🇫🇷🥖 (DINUM) 和德国 🇩🇪🥨 政府 (ZenDiS) 共同努力的结果。 我们是 BlockNotejs 和 Yjs 的骄傲赞助商。 我们一直在寻找新的公共合作伙伴（我们目前正在接纳荷兰 🇳🇱🧀），如果您有兴趣使用 Docs 或为其做出贡献，请随时与我们联系。

关于

一个可扩展的协作式笔记、wiki 和文档平台。使用 Django 和 React 构建。是 Notion 或 Outline 的开源替代方案。 docs.numerique.gouv.fr

主题

government documentation django opensource mit knowledge wiki reactjs self-hosted mit-license collaborative knowledge-base notion yjs realtime-collaboration g2g notion-alternative blocknotejs

资源

Readme

许可证

MIT license

行为准则

Code of conduct

安全策略

Security policy Activity Custom properties

Stars

894 stars

Watchers

13 watching

Forks

28 forks Report repository

Releases 22

v2.4.0 最新版本 Mar 6, 2025 + 21 releases

[Packages 0](https://github.