有没有办法用GitHub页面创建一个简单的Markdown wiki?

时间:2015-06-02 15:33:30

标签: github markdown github-pages

我想使用GitHub页面在Markdown中编写和托管我自己的系统管理wiki。

我已经使用myname.github.io创建了一个存储库,并且只在其中放置了一个带有文本的index.html文件:

Hello world!

结果我想要一个结构化的Markdown维基,例如:

index.html
io/mdadm.md
io/lvm.md
io/disks.md
mail/postfix.md
mail/mail.md
bacula/setup.md
bacula/tips.md
bash/tips.md
system/applications/repositories.md

当我导航到http://myname.github.io时,我希望看到包含指向另一个主页的主页。我将手动用HTML创建主页面。

当我导航到http://myname.github.io/system/applications/repositories或其他我希望看到渲染的Markdown HTML时。

如何创建此布局并强制GitHub将Markdown文件呈现为HTML?

有没有更好的方法将GitHub用作免费维基?

我也明白我可以在存储库和默认的GitHub存储库接口中使用标准md文件。但是,与从Markdown渲染的纯HTML相比,这个界面过于复杂。

1 个答案:

答案 0 :(得分:1)

您可以使用静态网站生成器Jekyll,它可以很好地与GitHub页面配合使用,并且可以直接使用Markdown。

请参阅documentation here