首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >我们应该使用什么来浏览在线文档?

我们应该使用什么来浏览在线文档?
EN

Software Recommendation用户
提问于 2017-08-21 01:18:38
回答 1查看 60关注 0票数 2

我是一个小型Linux发行版的项目负责人,我们正在用DocBook (XML)编写用户文档。我想将文档托管在某个Web服务器上,这样人们就可以在安装之前查阅文档,并在系统出现问题时在另一台计算机上进行故障排除。

如果有一个有点像OpenPOWER文档软膜文件的接口,那就太好了。

必须:

  • 开源许可证。
  • 支持发行版的多个版本,每个版本支持多本书籍(例如: Adélie 1.0:安装指南,管理指南;Adélie 2.0:安装指南,管理指南)
  • 永久URL (/version/bookname/章节或类似的“干净”URL)将是一种奖励。
  • 多语言支持。
  • 没有JavaScript,或者没有JavaScript的功能。

很好的富人:

  • 好的CSS支持像@media print这样的东西来打印,为屏幕阅读器提供优雅的降级。
  • 能够提供PDF或EPUB副本的书籍存档/离线阅读。
  • 服务器端的“搜索”功能来搜索书籍。例如,"install software"可以显示如何使用包管理器的结果。

我甚至不确定这样的系统是否存在,但如果存在,我在任何地方都找不到。现在,我正在手动将文档转换为MediaWiki,并将其提供给它,但这不是一个很好的解决方案,也不支持我们想要提供的那种主题或多语言支持。

该软件可以在任何支持x86或PowerPC的开源操作系统上运行,但如果我们能够在自己的Linux发行版上“自我宿主”,那就太好了。(显然,我们必须把它包装起来。)

谢谢你的建议!

EN

回答 1

Software Recommendation用户

发布于 2017-08-21 18:23:27

可以考虑的一种方法是将文档工作切换到重组文本 (大约有一些python实用脚本,比如 ),然后使用狮身人面像生成多种格式,有主题和更多的格式,您可以使用插件将docbook输出添加到狮身人面像,如果有必要,可以使用潘多克生成任何您需要但缺少的格式。狮身人面像配备了大约10个内置主题,或者您可以创建自己的。

对于狮身人面像感知主机选项,读文档是一个很好的选择。它支持主题,有全文搜索,是git,hg,svn & bzr感知的,当你用github和bitbucket集成将更改推到VCS时,它将通过web挂钩重建您的文档。它支持通过标记进行版本控制,并且可以承载多个版本的文档,并支持I18N。有对规范网址的支持。它还提供多种格式的文件下载:

上面提到的一切都是开源的。

票数 1
EN
页面原文内容由Software Recommendation提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://softwarerecs.stackexchange.com/questions/45296

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档