【问题标题】:Is there an easy way to convert Markdown into nice looking html documentation, including navigation? [closed]有没有一种简单的方法可以将 Markdown 转换为漂亮的 html 文档,包括导航? [关闭]
【发布时间】:2011-07-14 08:42:22
【问题描述】:

我们计划用 Markdown 编写我们的软件文档,但为了提供可点击的 web 视图,我们需要将 Markdown 文档转换为一组漂亮的 HTML 页面。

在我们的工作流程中,我们倾向于编写文档并将文档连同源代码和二进制文件一起交付给我们的客户。我发现很多 1-page 转换为 html 程序,但我想知道是否有一个很好的转换器,它可以使用 markdown 页面和样式元素,并能够将其转换为一个可行的网站,包括导航元素,如子页面等?

【问题讨论】:

  • 如果您愿意将 Markdown 替换为 reStructuredText(一种非常相似,如果更高级的语法),您可以使用 Sphinx 系统:sphinx.pocoo.org

标签: html documentation markdown documentation-generation


【解决方案1】:

这是最终用户文档还是面向开​​发人员的 API 文档?

对于第一种情况,我建议查看支持 Markdown 的 Wiki 软件。

对于第二种情况,您确实应该提及哪种编程语言。

【讨论】:

  • 它主要的最终用户文档,如安装说明/设计文档等。
【解决方案2】:

您应该查看Gollum。它是为 Github 的 wiki 提供支持的软件。它将文本文件的 git 存储库转换为 wiki。

【讨论】:

  • Gollum 看起来不错,但我们不会将我们的东西存储在 GitHub 上,所以使用 Gollum 似乎是不行的。
【解决方案3】:

这是一个blog,它介绍了几种使用 Markdown 维护文档的工具。 ScreenSteps 似乎最适合你。

【讨论】:

    猜你喜欢
    • 2020-03-22
    • 1970-01-01
    • 2022-09-24
    • 2012-04-30
    • 2010-09-06
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多