WikiDocs

机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

维基|文档

只是一个无数据库的 Markdown 平面文件 Wiki

Wiki|Docs 是一个注重隐私的 Wiki，适合那些希望拥有自己知识库的人。

可完全在你的计算机上通过独立桌面应用程序运行，或者使用 Docker 自行托管。你的内容保持为可携带的 Markdown 文件，而不是锁定在数据库或云服务中的数据。

项目主页: https://www.wikidocs.app

请考虑通过 PayPal 捐赠来支持此项目。

Wiki|Docs 的新功能

Wiki|Docs 2 是 在整个堆栈中用 TypeScript 完全重写 的版本：包括 NestJS 后端、Angular 网页客户端和 Electron 桌面应用程序。

新架构带来了：

• 一个 独立桌面应用程序，可将你的 Markdown 文件保存在电脑上，以便与所选择的 LLM 工具一起使用。
• 一个 自托管 Docker 服务，可以远程存储并服务相同的可移植数据（可私有或公开）。
• 桌面与远程同步，让你可以在本地工作并保持自托管实例中的知识库更新。
• REST API，使 Wiki|Docs 能够轻松集成到其他工具和工作流程中。

如果你在寻找项目的原始 PHP 版本，请参见
此分支。

为什么选择 Wiki|Docs？

Wiki|Docs 设计给重视 信息所有权 的用户。它保持了简洁的写作体验，同时让你自由在本地工作、在需要时自托管，以及在不同平台间迁移内容而不受 供应商锁定 限制。

快速开始

1. 尝试公共演示，立即探索 Wiki|Docs。
2. 下载桌面应用程序，将你的 wiki 完全保存在本地。
3. 运行 Docker 镜像，当你需要自托管实例或远程同步时使用。

功能

Wiki|Docs 结合了现代编辑器的便利性和纯文本 Markdown 的耐用性。无论您是在记录项目、构建个人知识库，还是共享团队 Wiki，相同的可移植文件始终处于您的工作流程核心。

• 开源
• 纯文本文件
• 无需数据库
• Markdown 语法
• YAML 前置内容
• 编辑器全 WYSIWYG
• 支持 KaTeX 数学公式
• 支持 Mermaid 图表
• 无限页面修订
• 上传和下载附件
• 上传图片（也可从剪贴板）
• 内容可按命名空间分类
• 公共和私有浏览
• 桌面和远程同步
• 语法高亮
• 多语言支持
• 深色模式
• 以及更多功能。

演示

在 http://demo.wikidocs.app 探索演示游乐场，使用以下 演示凭证：

认证：

用户名：john.doe@wikidocs.app
密码：wikidocs

如果 Wiki|Docs 对你有帮助，请考虑 给项目加星。

截图

这里展示了桌面和网页体验的部分内容。选择任意图片以 全尺寸 打开原始截图。

安装

要运行 Wiki|Docs，您可以使用桌面应用程序，也可以在自托管环境中运行它。

桌面端

下载 最新的 桌面应用程序版本 并运行安装程序。

应用程序将安装在您的系统上，然后您可以从开始菜单或桌面快捷方式启动它。

自托管

在 Docker Hub 上提供了一个 Docker 镜像，可以在容器中运行 Wiki|Docs。

在容器中运行 Wiki|Docs 是自托管的推荐方式，因为这是最简单、最快速的入门方法。

容器运行后，在 http://localhost:3210 打开网页客户端。后端 API 和 Swagger 文档可在 http://localhost:3210/api/ 获取。

快速运行

docker run -p 3210:3210 zavy86/wikidocs:2

附加设置

docker run --name wikidocs -d -p 3210:3210 -v /path/to/local/wikidocs/datasets/or/volume:/var/lib/wikidocs zavy86/wikidocs:2

使用 Docker Compose

使用以下 docker-compose.yml 文件通过 Docker Compose 运行 Wiki|Docs。

volumes:
  datasets:

services:
  wikidocs:
    image: zavy86/wikidocs:2
    environment:
      MODE: public|private
      SECRET: generate-a-secret-key-here
    volumes:
      - datasets:/var/lib/wikidocs/datasets
    ports:
      - "3210:3210"

同步

要将你的Wiki|文档数据跨多个设备同步，自己托管应用，并配置桌面应用连接到你的远程实例。

从文件菜单打开设置菜单（Windows上按Alt键）进入同步配置。

然后你可以访问并编辑你的Wiki|文档内容，从任何设备上在线访问。

迁徙

在从1.x.x版本（遗留版）迁移之前，务必创建完整备份数据集。

尽管本次发布结构发生重大变化，您的数据依然完全兼容。首次启动时，重新配置维基并创建管理员用户。所有现有文档随后将按预期正常工作。

唯一的手动调整**是将首页文档移至根目录，因为版本2不再使用遗留主页的主页栏杆作为索引页。

如果你用 Docker，可以指向端口 3210 而不是 80，并将数据集卷绑定到 /var/lib/wikidocs/datasets 。

帮助与文档

从以下资源开始，学习如何使用、托管、扩展或获得Wiki|文档。

• 请访问[www.wikidocs.app]（ https://www.wikidocs.app ）获取产品文档和指南。
• 在/api/打开你的自托管实例查看Swagger文档。
• 在[GitHub讨论]（ https://github.com/Zavy86/WikiDocs/discussions）中提问或分享想法。
• 通过[GitHub Issues]（ https://github.com/Zavy86/WikiDocs/issues）报告问题。

贡献

欢迎各种贡献，从错误报告、功能创意到文档、测试、代码和拉取请求审核。

• 报告一个错误
• 提出功能
• 改进文档
• 查看需要帮助的地方
• 寻找一个不错的首次问题
• 贡献代码

开发者

本节表彰那些帮助使该项目得以实现的人们。

如果您想参与项目，请查看[贡献]（https://github.com/Zavy86/WikiDocs/blob/main/CONTRIBUTING.md）文件以获取更多信息。

创建者

💡 Manuel Zavatta（网站）
| 领英
| YouTube
| 联系人 )

合作者

• Amin Persia
• Paulo Taborda

许可证

此项目根据 MIT 许可证 授权。