https://github.com/sivagao/readme-helper

a helper for github readme. it supports extract all md file to readme by a template generator
https://github.com/sivagao/readme-helper

Last synced: 23 days ago
JSON representation

a helper for github readme. it supports extract all md file to readme by a template generator

• Host: GitHub
• URL: https://github.com/sivagao/readme-helper
• Owner: sivagao
• Created: 2014-06-21T08:19:11.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-06-21T11:20:06.000Z (over 10 years ago)
• Last Synced: 2024-04-11T12:59:42.806Z (9 months ago)
• Language: JavaScript
• Size: 133 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## readme-helper

helper for generating readme file automatically

## Usage

- `npm install readme-helper`

- run `readme-helper` at your project folder

## TODO

- template at readme file

- more macros defined in js file etc

- more options for dir/file match

## Example

| 文件名        | 大小           | 修改时间  |

| ------------- |:-------------:| -----:|

| JSONStream-extracted.txt | 26460字节 | 2天前|

| JSONStream.js | 590字节 | 2小时前|

| [TODO]-util.md | 86字节 | 2天前|

| _all_docs | 159416字节 | 2天前|

| _all_docs.1 | 6698字节 | 2天前|

| asset-by-tj.js | 3489字节 | 2天前|

| basic.js | 252字节 | 2天前|

| blocked-test.js | 238字节 | 2天前|

| blocked.js | 454字节 | 2天前|

| chat-cmd.md | 0字节 | 1天前|

| co-test.js | 1568字节 | 2天前|