Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ehome-markdown-loader

ehome5MIT1.0.0

markdown doc webpack loader

webpack, loader, zanui, doc

readme

ehome-markdown-doc-loader

A webpack loader to parse markdown-doc markdown to structured data using unified.

Ecosystem

  • markdown-doc-loader
  • react-markdown-doc-loader
  • markdown-doc-loader-utils

Usage

Use as a webpack loader.

{
    module: {
        rules: [
            {
            test: /\.md$/,
            use: [
                // additional loaders to convert markdown AST to js
                'markdown-doc-loader'
            ]
            }
        ]
    }
}

Output

This loader emits an array of unified ASTs, so additional loaders must be used to convert these ASTs to js code.

Output array can have 3 types of ASTs, use contentType on the root to check type:

  • style: indicates a style tree, there will be only one style tree in the output if any. All styles tag in the markdown will be consolidated.
  • demo: indicates a demo tree, a demo consists of a code fragment and an optional title
  • markdown: indicates a normal markdown tree.

markdown-doc-loader-utils consists some utilities for working with these ASTs.