docor 自动从package.json生成排版好看的readme - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
turing
V2EX    Node.js

docor 自动从package.json生成排版好看的readme

  •  
  •   turing 2013-09-07 15:54:13 +08:00 3486 次点击
    这是一个创建于 4482 天前的主题,其中的信息可能已经有所发展或是发生改变。
    很多人懒得写readme,虽然markdown写起来已经够简单了,但是还是写不出好看的readme,因为觉得写文档是一件很麻烦的事情,我经常在npm上开坑,发现readme很多东西都可以从package.json中抓出来然后排版好,docor这个工具就做了这样一个工作。

    $ sudo npm install docor -g

    然后在你的目录下npm init之后,会有一个package.json文件,这个时候在本目录执行 docor 就可以看到生成的readme,根据pkg指定的license文件,和相应的ignore文件了。

    我还写了一些小功能,比如从pkg.main文件里将暴露出来的函数打印在readme中,方便以后写api文档。如果要指定文档的logo,可以在package.json中加一个 { "logo": "someurl" }

    目前有两个readme模板,如果希望要自己修改这个默认模板,可以在你的全局模块目录里修改 tpl/readme.md

    如果要新建中文语言的readme,可以这样: $ docor -c README.zh-cn.md,中文模板文件也在tpl目录下。

    Github:
    https://github.com/turingou/docor
    2 条回复    1970-01-01 08:00:00 +08:00
    turing
        1
    turing  
    OP
       2013-09-07 15:57:36 +08:00
    对了,docor的readme也是docor生成的。欢迎贡献代码或者补全license文件夹下的lincense文件,目前只有MIT,BSD和一个apache协议文件
    turing
        2
    turing  
    OP
       2013-09-07 16:10:28 +08:00
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     5210 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 3ms UTC 07:47 PVG 15:47 LAX 23:47 JFK 02:47
    Do have faith in what you're doing.
    ubao msn 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