MkDocs - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
Livid
61.5D
452.41D
V2EX    Markdown

MkDocs

  •  1
     
  •   Livid
    PRO
    2015-03-11 15:09:20 +08:00 8440 次点击
    这是一个创建于 3866 天前的主题,其中的信息可能已经有所发展或是发生改变。
    http://www.mkdocs.org/

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

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

    但是有一点不太好,就是文档一般都写在一个文件里,mkdocs的思想是分开写~~
    lepture
        8
    lepture  
       2015-03-11 22:40:20 +08:00
    没有 ref 的功能就不要自称文档生成了
    yuankui
        9
    yuankui  
       2015-03-12 10:10:23 +08:00
    @lepture
    @glasslion
    有推荐的吗?类似的
    luw2007
        10
    luw2007  
       2015-03-12 18:16:21 +08:00 via Android
    已经用上,+1
    abbatuu
        11
    abbatuu  
       2015-03-14 22:56:44 +08:00
    @yuankui mdwiki
    workwonder
        12
    workwonder  
       2015-05-26 17:33:01 +08:00
    @lepture 的 [nicojs](https://github.com/aralejs/nico-arale/) 不错,但是不够活跃,用起来有点孤单。
    workwonder
        13
    workwonder  
       2015-05-26 17:35:21 +08:00
    地址发错了,是: https://github.com/lepture/nico
    lepture
        14
    lepture  
       2015-05-26 18:22:34 +08:00
    @workwonder 是在 Alipay 前端小的,面有很多 Javascript 文的 trick。如果不是做前端,不建使用。目前主要是 arale 支付前端在用,有一的也在用。
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2925 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 32ms UTC 12:52 PVG 20:52 LAX 05:52 JFK 08:52
    Do have faith in what you're doing.
    ubao snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86