JarCasting
JarCasting JarCasting

update-sections

WebJar for update-sections

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

update-sections
Last Version

Last Version

0.1.2
Release Date

Release Date
Type

Type

jar
Description

Description

update-sections
WebJar for update-sections
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/jonschlinkert/update-sections

Download update-sections

Filename Size
update-sections-0.1.2.pom
update-sections-0.1.2.jar 6 KB
update-sections-0.1.2-sources.jar 22 bytes
update-sections-0.1.2-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/update-sections/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>update-sections</artifactId>
    <version>0.1.2</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/update-sections/
implementation 'org.webjars.npm:update-sections:0.1.2'
// https://jarcasting.com/artifacts/org.webjars.npm/update-sections/
implementation ("org.webjars.npm:update-sections:0.1.2")
'org.webjars.npm:update-sections:jar:0.1.2'
<dependency org="org.webjars.npm" name="update-sections" rev="0.1.2">
  <artifact name="update-sections" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='update-sections', version='0.1.2')
)
libraryDependencies += "org.webjars.npm" % "update-sections" % "0.1.2"
[org.webjars.npm/update-sections "0.1.2"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm » sections jar [0.1.8,0.2)

Project Modules

There are no modules declared in this project.

update-sections NPM version NPM downloads Build Status

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

Install

Install with npm:

$ npm install --save update-sections

Usage

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

update

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

Contributing

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

Building docs

(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:

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

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

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

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

Versions

Version
0.1.2