MkDocs

2015-03-11 15:09:20 +08:00
 Livid
http://www.mkdocs.org/

可以用 Markdown 写的文档站。
8132 次点击
所在节点    Markdown
14 条回复
Livid
2015-03-11 15:17:09 +08:00
而且现在 Read The Docs 也支持导入用 MkDocs 写的项目了:

http://docs.readthedocs.org/en/latest/getting_started.html
kxxoling
2015-03-11 16:22:15 +08:00
感觉 Markdown+YAML 写起来简单些。
Livid
2015-03-11 16:23:37 +08:00
@kxxoling RST 的标题下面的 === 要和标题长度一样的设定很讨厌,因为中文的宽度。
kxxoling
2015-03-11 18:16:27 +08:00
@Livid 其实是不必要的,构建的时候把 -W 参数改为 -w 就不那么严格了。如果没记错的话, ==== 只要是 4 个或以上就可以了。
不过 Sphinx 的语法太多了(虽然也更强大),不像 md 的一级标题、二级标题……可以直接写成 n 个 # 。
glasslion
2015-03-11 20:33:44 +08:00
MkDocs 不支持搜索 ,硬伤
bcxx
2015-03-11 21:21:38 +08:00
功能有点少啊…… 不好用
limbo0
2015-03-11 22:18:21 +08:00
最近也在用mkdocs,功能比较简单实用.

但是有一点不太好,就是文档一般都写在一个文件里,mkdocs的思想是分开写~~
lepture
2015-03-11 22:40:20 +08:00
没有 ref 的功能就不要自称文档生成了
yuankui
2015-03-12 10:10:23 +08:00
@lepture
@glasslion
有推荐的吗?类似的
luw2007
2015-03-12 18:16:21 +08:00
已经用上,+1
abbatuu
2015-03-14 22:56:44 +08:00
@yuankui mdwiki
workwonder
2015-05-26 17:33:01 +08:00
@lepture 的 [nicojs](https://github.com/aralejs/nico-arale/) 不错,但是不够活跃,用起来有点孤单。
workwonder
2015-05-26 17:35:21 +08:00
地址发错了,是: https://github.com/lepture/nico
lepture
2015-05-26 18:22:34 +08:00
@workwonder 這個是在 Alipay 時爲前端小組設計的,裏面有很多爲寫 JavaScript 文檔的 trick。如果不是做前端開發,不建議使用。這個目前主要是 arale 團隊與支付寶前端團隊在用,有一個騰訊的團隊也在用。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/176088

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX