从“mark down (.md)”文件生成 HTML 文档站点答案

【问题标题】：Generating HTML documentation site from "mark down (.md)" files从“mark down (.md)”文件生成 HTML 文档站点
【发布时间】：2017-07-20 08:38:15
【问题描述】：

是否有类似于“maven site plugin (javadoc)”的东西可用于节点？更具体地说，我们正在寻找一个节点包，它可以将 reactjs 项目中的 .md 文件转换为 html 文件。按照惯例，我们项目的每个文件夹都有一个包含详细文档的降价文件。我们正在寻找一种工具（cli），我们可以在构建过程中触发它以在构建（目标目录）中创建一个文档文件夹 - 特别对静态 HTML 生成感兴趣。

谢谢，圣

【问题讨论】：

标签： node.js reactjs npm r-markdown

【解决方案1】：

到目前为止，您在寻找什么？只需在谷歌上搜索“node MD to HTML”就可以得到很多潜在的模块，例如this one 和this one。

你有没有尝试过，但没有奏效？你在找什么？

【讨论】：

我对可用的工具/模块进行了快速研究以满足我们的要求。但是找不到任何可以匹配 maven 的站点插件的东西。如果有具有开箱即用功能的节点模块搜索所有文件夹以在构建期间将所有 .md 文件转换为 HTML 文件，那将是理想的。看来 showdown 和 ember-cli-showdown 功能强大，但无法与站点插件相提并论。谢谢
好吧，如果情况变得更糟，如果这些模块（或任何其他命令行工具）能够将 MD 转换为 HTML，那么就有一个简单的 shell 脚本来爬取您的目录并转换任何 MD 文件它找到 HTML 文件并将它们放入您的“文档”文件夹中应该不难。 shell 脚本总共只有几行。然后在您的 package.json 中，您可以告诉 npm 在构建过程中运行该脚本。我发现有时我必须对某些非标准文件这样做

【解决方案2】：

为我的项目找到 https://react-styleguidist.js.org/docs/documenting.html。很棒的工具（虽然它不等同于 Maven Site）。

【讨论】：