docume:从源文件在 README 中生成文档

时间:2024-06-26 22:09:54
【文件属性】:

文件名称:docume:从源文件在 README 中生成文档

文件大小:4KB

文件格式:ZIP

更新时间:2024-06-26 22:09:54

JavaScript

文档 从源文件在 README 中生成文档。 安装 $ npm install -g docume (下面的使用文档是通过DocuMe本身生成的,参见bin/docume文件的来源。) 用法 首先在你的 README 文件中放置一些占位符: # My README Some line here... <!--docume:path/to/source.js--> <!--/docume:path/to/source.js--> Author Name 预计您的源文件将具有 Markdown 格式的文档作为单行注释: /* path/to/source.js */ // this is a line that will be copied to README var str = 'Hello World' ; 现在运行命令: $ docume README.md 执照 麻省


【文件预览】:
docume-master
----.travis.yml(90B)
----bin()
--------docume(741B)
----index.js(1KB)
----package.json(775B)
----.gitignore(14B)
----README.md(884B)
----.jshintrc(389B)
----.editorconfig(345B)

网友评论