https://github.com/nichoth/readme-example

Pipe a code example into a readme template
https://github.com/nichoth/readme-example

Last synced: 11 months ago
JSON representation

Pipe a code example into a readme template

• Host: GitHub
• URL: https://github.com/nichoth/readme-example
• Owner: nichoth
• Created: 2015-11-18T22:05:33.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-18T22:29:09.000Z (over 10 years ago)
• Last Synced: 2025-03-10T06:37:22.514Z (over 1 year ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# readme example

Pipe a code example into a readme template

## install

    $ npm install -g readme-example

## example

Templates are underscore style.

_readmeTmpl.md:

    # my module

    ## example

    ```js

    <%= example %>

    ```

On the command line:

    $ cat example/code.js | readme-example _readmeTmpl.md > readme.md

Results in `readme.md`:

    # my module

    ## example

    ```js

    console.log('example');

    ```