@mapbox/jsxtreme-markdown-loader

Webpack loader to transform Markdown with interpolated JS and JSX into React components

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
817Nov 6, 2020Jun 18, 2017Minified + gzip package size for @mapbox/jsxtreme-markdown-loader in KB

Readme

@mapbox/jsxtreme-markdown-loader

Webpack loader to transform Markdown with interpolated JS and JSX into React components.

Runs files through the toComponentModule function of jsxtreme-markdown. Please read that documentation for more information.

For more information about jsxtreme-markdown features, read the README at the root of this monorepo.

Installation

npm install @mapbox/jsxtreme-markdown-loader

Usage

Follow the instructions for using Webpack loaders.

By default, the output of this loader is precompiled with Babel. You can bypass this step (and use your own compilation) by set the option precompile: false.

options

You can pass all of the options from toComponentModule.

Additional options for the loader:

getWrapper

Type: (resource: string) => string.

A function that receives the Webpack module's resource as an argument, and returns the path to a wrapper component. You can use this to automatically determine the wrapper component based on the Markdown file's path.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.