目前整个社区,没有一个正在使用的、集中的文档平台。
理想的社区文档中心
我认为一个理想的社区文档平台,需要满足以下几点:
- 统一的内容集中展示,方便用户自行查看一些已有总结,也方便索引和分享。
- 支持方便的社区协作,例如 GitHub。
- 可在线维护的编辑器,例如语雀、飞书、Notion、链滴等。
如果不能满足以上这些,难以兼顾维护者的维护体验与阅读者的阅读体验。
维护者的维护体验决定了文档内容的有效性和及时性,进一步将会影响社区用户们的阅读体验。
一些社区文档平台的现状
虽然目前思源社区已经有一些内容中心了,但是
- 要么近乎荒废(语雀自来水)
- 要么是半毛坯(社区开发者文档)
- 要么内容查找不方便(链滴)
- 要么是仅团队成员可维护(语雀)
- 要么是权限管理有问题(思源发布模式)
- 要么是文档维护不方便(社区开发者文档、飞书文档)
- 要么是在其他笔记软件上维护思源笔记的使用文档
- 其他一些可能忘记了的情况
所以我一直在寻找一个合适的方式,来构建思源社区的在线文档中心。
今天,似乎有了一个可行的方案。
思源笔记社区
之前想着共享一些维护好的思源 API,于是分享了《思源接口 ApiFox 文档》。现在发现,除了可以提供 API 在线文档以外,通过一些调整就是一个在线文档平台。
你可以通过下列地址查看效果:
优势
线上集中展示
打开上面的地址,你就能通过浏览器查看已经汇总的文档。
方便的维护体验
登录并加入以后,通过浏览器即可在线编辑内容。不会出现修改错别字、调整相关链接等情况,还需要本地构建运行才能查看最终效果。
唯一不足的地方,可能是侧边预览的 MD 编辑模式,而不是思源、语雀、飞书这样所见即所得的编辑器。
【亮点】支持在线运行思源 API
得益于 ApiFox,可以在浏览器中调用思源的 API,例如:API - 刷新思源界面。
更多有关于 API 的使用说明,今后请查看:思源社区 - APIs
【亮点】支持 MCP
在本平台添加的思源 API,通过 Apifox 的 MCP Server,你可用于 Cursor、VSCode + Cline 插件等支持 MCP 的平台中。
【亮点】开发经验复用
在使用一些接口时,特定的参数可直接维护在 API 对应的文档中。
【亮点】在线完成特定功能
由于 ApiFox 支持一定的编程能力,在这个站点中,还可以实现代码片段的发布、导入的过程。比如通过 组合 API - 获取代码片段、API - 设置代码片段、API - 移除代码片段 即可完成代码片段的导入和删除。
注:
该功能仅运行在你的电脑上,不存在数据泄露的风险。
对于类似的逻辑,未来也会对代码进行审查。
缺点
前面提到了不是所见即所得的编辑器,以及一些思源内部链接还需要单独进行处理。但总的来说,已经相对够好了。
邀您共建
整个平台完成搭建,所需的工作量还有很多,
- 链滴内容的汇总
- 思源使用指南的迁移
- 思源 API 的编写等
单靠个人是难以完成所有这些工作量的。
如果你想为思源社区贡献一份力量,欢迎加入我们。
只要你使用过思源笔记、语雀、飞书文档、Typora 等笔记软件产品,就能完成社区站点的维护工作。
如何报名
登录 Apifox,点击 加入项目 SiYuan Community 该链接,即可加入本项目。
具体贡献方式和维护指南,今后将在 思源社区 - 如何贡献 统一进行维护。
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于