就是用于写帮助文档,API文档的。能在线写,发布以后,用户可以在线查看。
有左侧列表,多级目录,像chm那样的。有全文检索,可以导出PDF\CHM等格式让用户下载。
gitbook有些慢,不想用。有没有国内的,或者开源自己能部署的。
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
根据您的需求,您希望找到一个能够在线编写API文档的工具,它应支持以下功能:
针对您的需求,虽然知识库中没有直接提供具体的工具推荐,但市面上有几款符合描述的工具您可以考虑:
Docusaurus:这是一个由Facebook维护的开源项目,支持Markdown编写文档,具有自动化的侧边栏生成、版本控制和多语言支持。它可以轻松构建具有多级目录的文档站点,并且可以自定义主题和插件来实现全文搜索等功能。您需要自己部署服务器来运行它。
Hugo:Hugo是一个非常快速的静态站点生成器,适合构建文档网站。它支持Markdown,可以通过主题和插件实现丰富的功能,包括多级目录和搜索。Hugo同样需要您自行部署,但搭建过程相对简单,且性能优秀。
GitLab Pages + GitLab Docs:如果您不介意使用国外服务,但对GitBook的速度不满意,可以考虑使用GitLab提供的Pages服务结合GitLab Docs特性。这允许您在GitLab仓库中编写Markdown文档,并通过GitLab Docs特性生成具有良好导航结构的文档网站,同时支持多种输出格式和在线预览。GitLab在国内也有镜像服务,可以提升访问速度。
AntV Docsite:这是蚂蚁集团开源的一款文档站点构建工具,专为技术文档设计,支持Markdown编写,内置多语言、多版本、实时预览等功能,同时也支持自动生成侧边栏和全文搜索。适用于构建具有复杂结构的技术文档站点。
以上工具均为开源项目,意味着您可以自由部署到自己的服务器上,从而满足对速度和服务地点的需求。选择时,请根据您的具体需求(如技术栈偏好、部署便利性、社区活跃度等)进行评估。