3.3.1 • Published 2 months ago

@hoast/process-markdown v3.3.1

Weekly downloads
1
License
MIT
Repository
github
Last release
2 months ago

@hoast/process-markdown

Convert markdown to HTML using Unified.

Install

npm install @hoast/process-markdown

Options

  • {String} property = 'contents' Dot notation path to the data property which should be processed as markdown.
  • {Array} remarkPlugins = [] Remark plugins. If the value in the array is an array the first will be instantiated if not already an instance, the subsequent values will be used as the plugin's options.
  • {Array} remarkParseOptions = {} Options for remark-parse plugin.
  • {Array} remarkRehypeOptions = {} Options for remark-rehype plugin.
  • {Array} rehypeRawOptions = {} Options for remark-raw plugin.
  • {Array} rehypePlugins = [] Rehype plugins. If the value in the array is an array the first will be instantiated if not already an instance, the subsequent values will be used as the plugin's options.
  • {Array} rehypeSanitizeOptions = {} Options for rehype-sanitize plugin.
  • {Array} rehypeStringifyOptions = {} Options for rehype-stringify plugin.

  • {Function} filter = null Custom filter function. The item data is given as the parameter. Return true if it should be processed, return false if this processor should be skipped.

  • {Number} logLevel = 2 Log level given to the logger.