sections
Advanced tools
Readme
Manipulate sections in a string of markdown.
Install with npm:
$ npm i sections --save
This is meant to be fast and opinionated, and only works with ATX headings.
var sections = require('sections');
Parses sections in a string of markdown and returns an object with two properties:
sections: an array of markdown "sections", delimited by ATX headings,result: the cumulative result of whatever is returned by the (optional) function that is passed as the second argument.{%= doc('examples/parse.md') %}
Params
string {String}fn {Function}returns {Object}Format sections. By default, if no filter function is passed, this:
Params
str {String}: Markdown stringfn {Function}: optional filter functionreturns {String}Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb, v0.9.0, on February 06, 2016.
FAQs
Manipulate sections in a markdown string. A 'section' is a block of content preceded by a valid markdown ATX heading.
We found that sections demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.