readme-example

0.0.3 • Public • Published

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');

```

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.0.3
    0
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.0.3
    0
  • 0.0.2
    0
  • 0.0.1
    0
  • 0.0.0
    1

Package Sidebar

Install

npm i readme-example

Weekly Downloads

1

Version

0.0.3

License

ISC

Last publish

Collaborators

  • nichoth