kloy / documentr
使用 markdown 格式编写的 Rails 指南风格文档
0.0.3
2012-04-24 03:12 UTC
Requires
- php: >=5.3.0
This package is not auto-updated.
Last update: 2024-09-14 12:32:42 UTC
README
Documentr 是一个受 Rails 指南启发的文档生成器。基本上,我长期以来一直需要为各种项目创建文档,但发现并没有真正好的解决方案。有一天,当我阅读 Rails 3 的 Rails 指南时,我突然想到,它们不仅看起来很漂亮,而且布局和组织得相当好。
因此,我抓取了一个 markdown 解析器和 Symfony YAML 组件,制作了 Documentr。我目前正在努力为它建立一个官方站点和文档集,但如果您非常渴望看看它能做什么,您可以从仓库中获取一个副本,稍微调整一下 documentr 文件以找到 src 中的内容,然后在示例目录中运行它。你应该能大致了解情况。如果不行,请耐心等待,我很快就会提供官方文档。
致谢
本程序深受 Rails 指南 的启发。
它还依赖于以下两个库
许可证
本软件根据 MIT 许可证 许可,所以请随意使用 :)