JSPM

md-insert

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 31
  • Score
    100M100P100Q65764F
  • License Apache-2.0

insert content under a markdown header or into a comment delimited region

Package Exports

  • md-insert

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (md-insert) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

md-insert

insert content under a markdown header or into a comment delimited region

with a cli!

Install - Usage - License: Apache-2.0

npm travis standard

Install

npm install md-insert

Usage

$ md-insert
usage: md-insert <file> [--header name] [--region name] [-i]

  --header name  Insert content under the header with this name.
  --region name  Insert content under the comment-delimited region with this
                 name.

  -i  Update <file> in place. If given, the result is written to <file>,
      instead of to standard output.

Examples:

  md-insert -i README.md --header API < generated-doc.md

  make-toc README.md | md-insert -i README.md --region toc

  document-prop-types src/index.js | md-insert TEMPLATE.md --header Props > README.md

Regions

--region inserts content into a comment-delimited region like this:

<!--toc start-->
<!--toc end-->
md-insert FILE.md -i --region toc < TOC.md
<!--toc start-->
contents of TOC.md
<!--toc end-->

Headers

--header inserts content below a header like this:

## Props
document-prop-types src/index.js | md-insert README.md -i --header Props

License

Apache-2.0