update-markdown-usage
Updates a markdown document section with CLI usage info via --help.
Last updated 5 months ago by fisch0920 .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install update-markdown-usage 
SYNC missed versions from official npm registry.

update-markdown-usage

Updates a markdown document section with CLI usage info via --help.

NPM Build Status JavaScript Style Guide

This module makes it easy for a node CLI module to update the usage section of its readme by pasting in the results of running with --help.

See the docs script in this module's package.json for a concrete example of how this readme's Usage section is updated automatically.

Install

npm install -g update-markdown-usage

Usage

  Usage: update-markdown-usage [options]

  Options:

    -V, --version           output the version number
    -f, --file <filename>   markdown file to update (defaults to local readme)
    -i, --stdin             read usage from stdin (defaults to running pkg binary with --help)
    -P, --prefix <string>   optional markdown section prefix
    -S, --suffix <string>   optional markdown section suffix
    -s, --section <string>  name of markdown section to update (default: usage)
    -W, --no-write          write result to stdout (defaults to updating markdown file)
    -h, --help              output usage information

NPM scripts

  "scripts: {
    "docs": "update-markdown-usage"
  },

Related

License

MIT © Travis Fischer

Current Tags

  • 1.0.7                                ...           latest (5 months ago)

9 Versions

  • 1.0.7                                ...           5 months ago
  • 1.0.6                                ...           5 months ago
  • 1.0.5                                ...           a year ago
  • 1.0.4                                ...           a year ago
  • 1.0.3                                ...           a year ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 31
Dependencies (6)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |