@deskeen/web-builder-inline-markdown

0.1.3 • Public • Published

Web Builder Module - Inline Markdown files

This module allows the @deskeen/web-builder engine to inline Markdown files.

It uses the @deskeen/markdown parser under the hood to parse the text.

Install

npm install @deskeen/web-builder
npm install @deskeen/web-builder-inline-markdown

Usage

And add the module to the list of modules:

const builder = require('@deskeen/web-builder')
const builder.build([
  source: [
    // List of files or directories that include
    // {{inlineMD:file.md}} tags
  ],
  modules: [
    [
      '@deskeen/web-builder-inline-markdown',
      {
        assets: [
          // List of directories that include
          // the markdown files included in the tags
        ],
        onAssetsLoad: assetsMap => {
          // Optional event that allows to edit the content
          // of the assets before passing it to the parser.
        },
        parserOptions: {
          // See https://github.com/deskeen/markdown
          // for a complete list of options
        }
      }
    ]
  ]
])

Contact

You can reach me at {my_firstname}@{my_name}.fr

Licence

MIT Licence - Copyright (c) Morgan Schmiedt

Package Sidebar

Install

npm i @deskeen/web-builder-inline-markdown

Weekly Downloads

4

Version

0.1.3

License

MIT

Unpacked Size

5.58 kB

Total Files

5

Last publish

Collaborators

  • deskeen