https://github.com/mastersign/mddata
Extracts data from Markdown documents
https://github.com/mastersign/mddata
Last synced: 24 days ago
JSON representation
Extracts data from Markdown documents
- Host: GitHub
- URL: https://github.com/mastersign/mddata
- Owner: mastersign
- License: mit
- Created: 2015-10-29T15:08:19.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T21:41:17.000Z (about 2 years ago)
- Last Synced: 2025-08-28T05:04:36.252Z (12 months ago)
- Language: JavaScript
- Size: 98.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# MdData
[![npm package][npm-img]][npm-url]
[![dependency status][libraries-img]][libraries-url]
[![build status][travis-img]][travis-url]
> extracting hierarchic data from [Markdown] documents
## Application
_MdData_ parses a [Markdown] document and extracts a hierarchic data structure,
which represents headlines and lists.
Take a look at the [test document](test/data/data.md) and the [result](test/data/data.json).
It can be used as a function or with [Gulp].
## Interface
_MdData_ makes use of [GulpText _simple_][gulp-text-simple] to provide the API.
Therefore, it currently supports three ways of usage.
1. Use the `readFileSync(path)` function, to get the extracted
data of a [Markdown] file.
2. Specify a [Markdown] string, to get the extracted data.
3. Give no arguments, to get a gulp transformation.
### Transform a file directly
Use the function `readFileSync(path)` and specify a path to the [Markdown] file.
``` js
var mddata = require('mddata');
var result = mddata.readFileSync('project_a/docs/index.md');
```
### Transform a string
Give a [Markdown] string to extract the hierarchic data.
``` js
var mddata = require('mddata');
var documentPath = 'project_a/docs/index.md';
var result = mdinclude('# Introduction ...');
```
### Create a Gulp transformation
``` js
var mddata = require('mddata');
var gulp = require('gulp');
gulp.task('preprocess-markdown', function() {
return gulp.src('docs/*.md')
.pipe(mddata())
.pipe(gulp.dest('out'));
});
```
## License
_MdData_ is published under the MIT license.
[npm-url]: https://www.npmjs.com/package/mddata
[npm-img]: https://img.shields.io/npm/v/mddata.svg
[libraries-url]: https://libraries.io/npm/mddata
[libraries-img]: https://img.shields.io/librariesio/github/mastersign/mddata.svg
[travis-img]: https://img.shields.io/travis/mastersign/mddata/master.svg
[travis-url]: https://travis-ci.org/mastersign/mddata
[Gulp]: http://gulpjs.com
[Markdown]: https://daringfireball.net/projects/markdown/
[gulp-text-simple]: https://www.npmjs.com/package/gulp-text-simple