markdown-replace-section

Replace a section in a Markdown file with different content.

Installation

npm install --save markdown-replace-section

Usage

Code

import replaceSection from "markdown-replace-section";
 
const markdown =
`
Title
=====
 
Old content
 
Other title
===========
 
Some other content
`;
 
const hungry = true; // Set to false to keep the Subtitle section
console.log(replaceSection(markdown, "Title", "New content", hungry));

Output

Title
=====
 
New content
 
Other title
===========
 
Some other content

The package also comes with an executable markdown-replace-section for usage in shell scripts

Usage: src/cli.js <input_file> <heading_name> [<output_file>] [--not-hungry]

Reads the Markdown file <input_file> and replaces everything between the first
heading named <heading_name> and the next heading of the same level with the
content read from stdin.

The result is written to <output_file> or stdout.

Options:
  --not-hungry  Stop at the first heading             [boolean] [default: false]
  --help, -h    Show help                                              [boolean]

License

See LICENSE