微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

ruby – 如何使用jekyll写一个项目的文档?

我正在为我的项目写一份文件.我在 python中完成了我的项目.但是我选择 jekyll写下文档.但是我没有找到任何有用的文档.还有很多基本问题在我身边.例如如何在jekyll等中生成模板等等,请建议我任何帮助完整的文档或使用jkeyll分享您的想法文档.

解决方法

Jekyll非常博客导向.它可以用于生成静态HTML页面,但它不适用于记录软件项目(除非您打算使用博客记录文档).

如果您的项目是在github上托管的,那么现在使用github的wiki可能会更好一些.

如果您还想自动生成文档,那里有更好的解决方案 – pydoc一个,但还有其他的,如Sphinx或最新到达,Dexy.

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐