最简单的静态站点生成器，用于带有导航的 Markdown 文件

Question

这听起来可能是很多人问过的问题，但我认为我的用例有些独特。我在遍历所有各种静态站点生成器和 jekyll 主题时遇到了麻烦。

这就是我想要实现的目标：我需要从 github markdown 文件目录生成静态网站，并带有自动生成的侧边栏导航。在 2024 年，这不可能不存在。

本质上，给定一个（可能嵌套的）.md 文件目录，我需要生成一个静态网站：

/README.md
/explanations/README.md
/explanations/some_name/another_file.md
/how-to-guides/README.md

应该导致：

/README.html
/explanations/README.html
/explanations/some_name/another_file.html
/how-to-guides/README.html

到目前为止，这很简单，有很多 Markdown 渲染器，但是我需要一个链接到每个页面的侧边栏导航：

README
explanations
    README
    some_name
        another_file
how-to-guides
    README

它甚至不需要看起来特别好，但如果能做到的话那就太好了。原因是我正在创建一个文档门户并搜索公司内的内部 github 企业安装。我想支持在 github markdown 中编写文档的开发人员，但不幸的是，由于安全限制，我无法使用我的搜索爬虫直接索引 github。但是，我可以呈现他们的文档，将它们复制到其他地方，让爬虫对其进行索引并链接回 github 企业 URL。

这也是为什么静态站点生成器保留相同的目录结构和名称非常重要的原因。我的搜索结果不会链接回

static_site_host.company_name.com/GHE_org/project_name/README.md

，而是链接到

github.company_name.com/GHE_org/project_name/blob/main/README.md

我将有很多这样的 Markdown 存储库要转换为网站，我真的需要能够自动完成它。

侧边栏导航只是为了让网络爬虫可以索引其他页面。我可以使用 Markdown 渲染器并编写一个脚本来创建侧边栏（或者甚至只是一个链接列表适用于爬虫），但我认为有人已经写了这样的东西，它看起来会更好。我只是找不到它，因为有很多静态网站 gen、jekyll 主题等，我想我应该先问一下。

就是这样。 Markdown 文件目录 -> 带有侧栏导航的 html。而已。没有博客，没有标签，没有什么花哨的东西。只需降价为 html + 导航。与 github 显示 markown 的方式非常相似。

抱歉，如果这个问题重复！我没找到。

Answer 1

MkDocs 正是我正在寻找的东西。开箱即用，它完全符合我的要求。

Docsify、VuePress 和 Eleventy 也是我正在考虑的选项。我首先尝试了 docsify，它看起来很有希望，但它没有为我自动生成导航。

测试完 MkDocs 后，我没有看到继续的理由。我仍然会尝试 VuePress 和 Eleventy，以及人们建议的任何其他选项。

如果有人提出更好的选择，我将不回答这个问题。