update-sections   

Easily prepend, append, inject or replace 'sections' in a markdown string.

Install

Install with npm:

``sh
$ npm install --save update-sections
`

Usage

`js
var fs = require('fs');
var update = require('update-sections');
var readme = fs.readFileSync('README.md', 'utf8');
var snippet = fs.readFileSync('contributing.md', 'utf8');

// Inject the contributing.md string before the "License" section
var str = update(readme, 'License', snippet, 'before');
`

API

$3

Re-write a layout with "sections" defined in a declarative configuration. The sections property must be an array of section object, and each object must have all params defined: contents, heading and placement.

Supported placement values are:

* inner (or aliases: inside and between): inject the content directly after the heading, before the content of a section
* before (or alias prepend): inject the content before the specified section's heading
* after (or alias append): inject the content after the specified section's heading

Params

* contents {String}: the string with sections to update
* heading {String}: the heading of the existing section to match for placement
* value {String}: the "snippet" to inject for the section
* placement {String}: where to place the new content, relative to the specified heading.
* returns {String}

About

$3

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

$3

_(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)_

To generate the readme and API documentation with verb:

`sh
$ npm install -g verb verb-generate-readme && verb
`

$3

Install dev dependencies:

`sh
$ npm install -d && npm test
``

$3

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

$3

Copyright © 2016, Jon Schlinkert.
Released under the MIT license.

*

_This file was generated by verb, v0.9.0, on July 27, 2016._