V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
turing
V2EX  ›  Node.js

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

  •  
  •   turing · 2013-09-07 15:54:13 +08:00 · 3043 次点击
    这是一个创建于 4094 天前的主题,其中的信息可能已经有所发展或是发生改变。
    很多人懒得写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   ·   实用小工具   ·   2715 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 29ms · UTC 12:29 · PVG 20:29 · LAX 04:29 · JFK 07:29
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.