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

发布时间：2020-12-16 19:56:07 所属栏目：百科来源：网络整理

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

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

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

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

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!