V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
Daring Fireball: Markdown
CommonMark
MacDown Open Source Markdown Editor
Marked
GitHub Flavored Markdown
Livid
270.9D
571.27D
V2EX  ›  Markdown

MkDocs

  •  1
     
  •   Livid ·
    PRO
    · Mar 11, 2015 · 8713 views
    This topic created in 4074 days ago, the information mentioned may be changed or developed.
    http://www.mkdocs.org/

    可以用 Markdown 写的文档站。
    14 replies    2015-05-26 18:22:34 +08:00
    Livid
        1
    Livid  
    MOD
    OP
    PRO
       Mar 11, 2015
    而且现在 Read The Docs 也支持导入用 MkDocs 写的项目了:

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

    但是有一点不太好,就是文档一般都写在一个文件里,mkdocs的思想是分开写~~
    lepture
        8
    lepture  
       Mar 11, 2015
    没有 ref 的功能就不要自称文档生成了
    yuankui
        9
    yuankui  
       Mar 12, 2015
    @lepture
    @glasslion
    有推荐的吗?类似的
    luw2007
        10
    luw2007  
       Mar 12, 2015 via Android
    已经用上,+1
    abbatuu
        11
    abbatuu  
       Mar 14, 2015
    @yuankui mdwiki
    workwonder
        12
    workwonder  
       May 26, 2015
    @lepture 的 [nicojs](https://github.com/aralejs/nico-arale/) 不错,但是不够活跃,用起来有点孤单。
    workwonder
        13
    workwonder  
       May 26, 2015
    地址发错了,是: https://github.com/lepture/nico
    lepture
        14
    lepture  
       May 26, 2015
    @workwonder 這個是在 Alipay 時爲前端小組設計的,裏面有很多爲寫 JavaScript 文檔的 trick。如果不是做前端開發,不建議使用。這個目前主要是 arale 團隊與支付寶前端團隊在用,有一個騰訊的團隊也在用。
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   1026 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 60ms · UTC 18:51 · PVG 02:51 · LAX 11:51 · JFK 14:51
    ♥ Do have faith in what you're doing.