@static-pages/markdown-reader NPM

Static Pages / Markdown reader

Front matter style file reader. Reads every file matching a given pattern. Produces an iterable.

Usage

import reader from '@static-pages/markdown-reader';

const iterable = reader({
  attrKey: 'attr',
  bodyKey: 'body',
  cwd: 'pages',
  pattern: '**/*.md',
  ignore: 'files-to-ignore*',
  incremental: false,
});

// one item in the iterable:
// {
//   header: {
//     cwd: '/path/to/pages',
//     path: 'folder/file.md',
//     dirname: 'folder',
//     basename: 'file',
//     extname: '.md'
//   },
//   attr: {
//     frontMatterAttribute1: '...',
//     frontMatterAttribute2: '...',
//     ...
//   },
//   body: 'markdown content'
// }

Docs

`reader(options: Options): Iterable<Data>`

`Options`

options.attrKey (default: empty) file contents will be put under this key in the returned data object to prevent polluting the root (eg. prevent the overwrite of the header or body field). When left empty the contents are spread into the root object.
options.bodyKey (default: body) markdown body text will be presented under this key. This allow you to give a better matching key for the markdown body if it helps your workflow.
options.cwd (default: .) sets the current working directory.
options.pattern (default: **/*.md) glob pattern(s) that selects the files to read. Can be a string or a string array.
options.ignore (default: undefined) glob pattern(s) that selects the files to ignore. Can be a string or a string array.
options.encoding (default: utf-8) defines the returned file encoding. Possible values are the same as the encoding argument of fs.readFile.
options.incremental (default: false) enables the incremental reads. See more at @static-pages/file-reader docs page.

`Data`

data.header contains metadata about the file.
- header.cwd is the absolute path of the cwd set in the options.
- header.path is the file path relative to the header.cwd.
- header.dirname is equivalent to path.dirname(header.path).
- header.basename is equivalent to path.basename(header.path, header.extname).
- header.extname is equivalent to path.extname(header.path).
data.attr contains attributes defined in the frontmatter style markdown. Property name customizable with options.attrKey.
data.body is the markdown source text. Property name customizable with options.bodyKey.