我编写了 Hotplate,这是一个很棒的(但尚未完成)Nodejs 框架,目前它的文档绝对为 0。
它不是一个“api”——Hotplate 是一种专注于由几个模块发送和收听的“消息”的框架。因此,文档很棘手(它不是要记录一堆函数,API 风格)。
我的想法是在 Github 上创建一个类似 Mongoose 的网站:
http://mongoosejs.com/docs/guide.html
我将如何为自己的项目做到这一点?
我编写了 Hotplate,这是一个很棒的(但尚未完成)Nodejs 框架,目前它的文档绝对为 0。
它不是一个“api”——Hotplate 是一种专注于由几个模块发送和收听的“消息”的框架。因此,文档很棘手(它不是要记录一堆函数,API 风格)。
我的想法是在 Github 上创建一个类似 Mongoose 的网站:
http://mongoosejs.com/docs/guide.html
我将如何为自己的项目做到这一点?
Github 推荐的方法是使用github pages来托管Jekyll。
您可以使用他们的“自动页面生成器”来加快该过程。
请参阅:https ://help.github.com/articles/creating-pages-with-the-automatic-generator