探索未来文档的新方式：Octopus 内部维基系统

1、项目介绍

想象一下一个无需服务器和数据库的内部维基系统，支持软件图表，只需Markdown就能创建出专业级别的文档。这就是 Octopus，一个采用JAMstack架构，基于Google Firebase的无服务器内部wiki平台。它提供了一种优雅的方式来创建和管理您的团队知识库。

2、项目技术分析

Octopus 是一个由 Graphviz 和 flowchart.js 支持的Markdown文档增强工具，允许您在文档中轻松插入系统图和流程图。通过使用JAMstack理念，结合Google Firebase作为后端，您可以做到无服务器部署，并利用Netlify等CDN服务免费托管应用。

• 用户可以通过多种身份验证提供商（如Google、GitHub）登录。
• 可配置权限规则，限制特定用户的阅读和编辑权限。
• 支持自定义域名。

3、项目及技术应用场景

Octopus 深受IT团队喜爱，尤其适用于：

• 记录和更新复杂的软件系统结构和流程。
• 创建易于理解的技术文档，包括系统图和流程图。
• 管理团队知识库，包括项目规范、代码实践指南等。
• 培训新员工，让他们快速熟悉业务环境和工作流程。

4、项目特点

• Markdown编写：易于学习，强大而灵活的文本格式。
• 图形化展示：内置对Graphviz和flowchart.js的支持，方便绘制软件图表。
• 实时协作：查看谁正在浏览或编辑文章，促进团队协作。
• 可定制：基于React构建，可以自由调整前端样式和功能。

示例系统图

页面编辑与Markdown

安装与部署

Octopus 的安装和部署过程简单明了，只需几个步骤即可让您的知识库上线运行。具体步骤请参照项目README。

总结

Octopus 不仅是一个内部维基系统，更是一种推动团队合作和信息共享的新方法。无论您是技术专家还是非技术人员，都能快速上手并从中受益。现在就加入我们，探索Octopus带来的可能性，为您的团队创造更加高效的工作环境！

许可证：本项目遵循MIT License。详细信息见LICENSE文件。

作者：Bartosz Olchówka，CTO @ LiveChat

让我们一起进入无服务器文档的新时代！