{ "name": "section-matter", "versions": { "0.1.0": { "name": "section-matter", "description": "Like front-matter, but supports multiple sections in a document.", "version": "0.1.0", "homepage": "https://github.com/jonschlinkert/section-matter", "author": { "name": "Jon Schlinkert", "url": "https://github.com/jonschlinkert" }, "repository": { "type": "git", "url": "git+https://github.com/jonschlinkert/section-matter.git" }, "bugs": { "url": "https://github.com/jonschlinkert/section-matter/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=4" }, "scripts": { "test": "mocha" }, "dependencies": { "extend-shallow": "^2.0.1", "kind-of": "^6.0.0" }, "devDependencies": { "gulp-format-md": "^1.0.0", "js-yaml": "^3.10.0", "mocha": "^4.0.1" }, "keywords": [ "matter", "section" ], "verb": { "toc": false, "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "related": { "list": [ "gray-matter", "assemble", "verb" ] }, "lint": { "reflinks": true } }, "gitHead": "9d5031ce958ed91b2b8a8a1bc3aeebad7d54b4a1", "_id": "section-matter@0.1.0", "_npmVersion": "5.5.1", "_nodeVersion": "8.7.0", "_npmUser": { "name": "jonschlinkert", "email": "github@sellside.com" }, "dist": { "integrity": "sha512-c9iNIscLOPwaSVrmTwneh9URg6jo7dJB0TdTBqWQEWn4QBctiat2EGjabi8mVu6mNdLARLB+T3WVaI13kcRfNg==", "shasum": "1911ce40faa7f0f3bc93431d7a2986a69c7824a0", "tarball": "https://registry.npmjs.org/section-matter/-/section-matter-0.1.0.tgz" }, "maintainers": [ { "name": "jonschlinkert", "email": "github@sellside.com" } ], "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/section-matter-0.1.0.tgz_1508743376526_0.4337844147812575" }, "directories": {}, "contributors": [] }, "1.0.0": { "name": "section-matter", "description": "Like front-matter, but supports multiple sections in a document.", "version": "1.0.0", "homepage": "https://github.com/jonschlinkert/section-matter", "author": { "name": "Jon Schlinkert", "url": "https://github.com/jonschlinkert" }, "repository": { "type": "git", "url": "git+https://github.com/jonschlinkert/section-matter.git" }, "bugs": { "url": "https://github.com/jonschlinkert/section-matter/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=4" }, "scripts": { "test": "mocha" }, "dependencies": { "extend-shallow": "^2.0.1", "kind-of": "^6.0.0" }, "devDependencies": { "gulp-format-md": "^1.0.0", "js-yaml": "^3.10.0", "mocha": "^4.0.1" }, "keywords": [ "matter", "section" ], "verb": { "toc": false, "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "related": { "list": [ "gray-matter", "assemble", "verb" ] }, "lint": { "reflinks": true } }, "gitHead": "9d5031ce958ed91b2b8a8a1bc3aeebad7d54b4a1", "_id": "section-matter@1.0.0", "_npmVersion": "5.5.1", "_nodeVersion": "8.7.0", "_npmUser": { "name": "jonschlinkert", "email": "github@sellside.com" }, "dist": { "integrity": "sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==", "shasum": "e9041953506780ec01d59f292a19c7b850b84167", "tarball": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz" }, "maintainers": [ { "name": "jonschlinkert", "email": "github@sellside.com" } ], "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/section-matter-1.0.0.tgz_1508743549323_0.7964347959496081" }, "directories": {}, "contributors": [] } }, "time": { "modified": "2017-10-23T07:25:50.429Z", "created": "2017-10-23T07:22:57.463Z", "0.1.0": "2017-10-23T07:22:57.463Z", "1.0.0": "2017-10-23T07:25:50.429Z" }, "users": {}, "dist-tags": { "latest": "1.0.0" }, "_uplinks": { "npmjs": { "etag": "W/\"a41f7d718ecf3a963b2d68d3019a2cb7\"", "fetched": 1600679305786 } }, "_distfiles": { "section-matter-0.1.0.tgz": { "url": "https://registry.npmjs.org/section-matter/-/section-matter-0.1.0.tgz", "sha": "1911ce40faa7f0f3bc93431d7a2986a69c7824a0", "registry": "npmjs" }, "section-matter-1.0.0.tgz": { "url": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", "sha": "e9041953506780ec01d59f292a19c7b850b84167", "registry": "npmjs" } }, "_attachments": { "section-matter-1.0.0.tgz": { "shasum": "e9041953506780ec01d59f292a19c7b850b84167" } }, "_rev": "2-34246f2be53be779", "_id": "section-matter", "readme": "# section-matter [![NPM version](https://img.shields.io/npm/v/section-matter.svg?style=flat)](https://www.npmjs.com/package/section-matter) [![NPM monthly downloads](https://img.shields.io/npm/dm/section-matter.svg?style=flat)](https://npmjs.org/package/section-matter) [![NPM total downloads](https://img.shields.io/npm/dt/section-matter.svg?style=flat)](https://npmjs.org/package/section-matter) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/section-matter.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/section-matter) \n\n> Like front-matter, but supports multiple sections in a document.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save section-matter\n```\n\n## Usage\n\n**Params**\n\n* `input` **{String|Buffer|Object}**: If input is an object, it's `content` property must be a string or buffer. \n* **{Object}**: options \n* `returns` **{Object}**: Returns an object with a `content` string and an array of `sections` objects. \n\n**Example**\n\n```js\nvar sections = require('{%= name %}');\nvar result = sections(input, options);\n// { content: 'Content before sections', sections: [] }\n```\n\nSee available [options](#options).\n\n## Example\n\n_With the exception of front-matter, **which must be the very first thing in the string**, the opening delimiter of all other sections must be followed by a string to be used as the `key` for the section._\n\nGiven the following string:\n\n```\nContent before the sections.\n\n---\n\nMore content.\n\n---one\ntitle: One\n---\n\nThis is the first section.\n```\n\nThe following code:\n\n```js\nconsole.log(sections(input));\n```\n\nResults in:\n\n```js\n{ \n content: 'Content before the sections.\\n\\n---\\n\\nMore content.\\n',\n sections: [\n { \n key: 'one',\n data: 'title: One',\n content: '\\nThis is the first section.' \n } \n ] \n}\n```\n\n## Options\n\n### options.section_parse\n\n**Type**: `function`\n\n**Default**: `undefined`\n\nFunction to be called on each section after it's parsed from the string.\n\n**Example**\n\nGiven the following string (`foo.md`):\n\n```\nThis is content before the sections.\n\n---one\ntitle: First section\n---\n\nThis is section one.\n\n---two\ntitle: Second section\n---\n\nThis is section two.\n```\n\nUsing the following custom `section_parse` function:\n\n```js\nvar fs = require('fs');\nvar path = require('path');\nvar yaml = require('js-yaml');\nvar sections = require('section-matter');\n\nvar str = fs.readFileSync('foo.md');\nvar options = {\n section_parse: function(section) {\n console.log(section)\n section.key = 'section-' + section.key;\n section.data = yaml.safeLoad(section.data);\n }\n};\n\nvar result = sections(str, options);\nconsole.log(result);\n```\n\nResults in:\n\n```js\n{\n content: 'This is content before the sections.\\n',\n sections: [\n {\n key: 'section-one',\n data: { title: 'First section' },\n content: '\\nThis is section one.\\n'\n },\n {\n key: 'section-two',\n data: { title: 'Second section' },\n content: '\\nThis is section two.\\n'\n }\n ]\n}\n```\n\n### options.section_delimiter\n\n**Type**: `string`\n\n**Default**: `---`\n\nDelimiter to use as the separator for sections. _With the exception of front-matter, which must be the very first thing in the string, the opening delimiter of all other sections must be followed by a string to be used as the `key` for the section._\n\n**Example**\n\n```js\nvar input = '~~~\\ntitle: bar\\n~~~\\n\\nfoo\\n~~~one\\ntitle: One\\n~~~\\nThis is one';\nconsole.log(sections(input, {section_delimiter: '~~~'}));\n```\n\nResults in:\n\n```js\n{\n content: '',\n sections: [\n {\n key: '',\n data: 'title: bar',\n content: '\\nfoo'\n },\n {\n key: 'one',\n data: 'title: One',\n content: 'This is one'\n }\n ]\n}\n```\n\n## About\n
\n Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n
\n\n
\n Running Tests\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install && npm test\n```\n\n
\n\n
\n Building docs\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme && verb\n```\n\n
\n\n### Related projects\n\nYou might also be interested in these projects: \n\n- [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble \"Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit\")\n- [gray-matter](https://www.npmjs.com/package/gray-matter): Parse front-matter from a string or file. Fast, reliable and easy to use. Parses YAML… [more](https://github.com/jonschlinkert/gray-matter) | [homepage](https://github.com/jonschlinkert/gray-matter \"Parse front-matter from a string or file. Fast, reliable and easy to use. Parses YAML front matter by default, but also has support for YAML, JSON, TOML or Coffee Front-Matter, with options to set custom delimiters. Used by metalsmith, assemble, verb and \")\n- [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb \"Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.\") \n\n### Contributors\n\n### Author\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\nCopyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 23, 2017._" }