如何在GitHub上创建文档站点？

Question

我编写了Hotplate，一个很棒的（还没有完整的）Nodejs框架，在这一点上，它有绝对的0文档。

它不是“api” - Hotplate是一种框架，专注于由几个模块发送和收听的“消息”。因此，文档很棘手（它不是不关于记录一堆函数，API风格）。

我的想法是在Github上创建像Mongoose这样的网站：

http://mongoosejs.com/docs/guide.html

我如何为自己的项目做到这一点？

Answer 1

Github推荐的方法是使用github pages来托管Jekyll。

您可以使用他们的“自动页面生成器”来加快这一过程。

请参阅：https://help.github.com/articles/creating-pages-with-the-automatic-generator