Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ticky/markdown-component-loader
📑 Turn Markdown into dynamic, stateless React components
https://github.com/ticky/markdown-component-loader
loader markdown react-components
Last synced: 15 days ago
JSON representation
📑 Turn Markdown into dynamic, stateless React components
- Host: GitHub
- URL: https://github.com/ticky/markdown-component-loader
- Owner: ticky
- License: mit
- Created: 2016-10-17T06:25:48.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-22T23:04:12.000Z (22 days ago)
- Last Synced: 2024-10-23T13:39:03.611Z (21 days ago)
- Topics: loader, markdown, react-components
- Language: JavaScript
- Homepage: https://ticky.github.io/markdown-component-loader/
- Size: 18.6 MB
- Stars: 71
- Watchers: 3
- Forks: 8
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Markdown Component Loader
[](https://www.npmjs.com/package/markdown-component-loader)  [](https://travis-ci.org/ticky/markdown-component-loader) [](https://codecov.io/gh/ticky/markdown-component-loader)
Turn Markdown into dynamic, stateless React components
- Integrate documentation and other prose with user info and context
- Show your real UI components alongside documentation
- Add other dynamic components inside documentation
## Usage
### Installation
```shell
yarn add markdown-component-loader
```
\~_or_\~
```shell
npm install --save markdown-component-loader
```
You'll need both Babel and Webpack in order to use it.
### Webpack Configuration
You then need to configure Webpack to use the loader, in your `webpack.config.js`;
```javascript
module.exports = {
module: {
loaders: [
{
test: /\.mdx$/i,
loader: 'babel-loader!markdown-component-loader'
},
{...more}
]
},
{...more}
};
```
### Usage and Syntax
`mdx` allows you interleave both React props and React components within your prose and code snippets! `mdx` files may optionally start with yaml-formatted front-matter.
Front-matter accepts `imports`, which will be included in the React component's definition. Other front-matter keys are added as static properties of the resultant Markdown component.
Here's an example of an `mdx` file;
```markdown
---
imports:
'{ name, version }': ./package.json
displayName: MarkdownComponentLoaderReadme
---
This is a _Markdown Component_ file. Here you can include JSX-style assignment expressions; this component was generated using version {{ version }} of {{ name }}!
Props passed to this component are available as `props`, so you can embed those too! Hello there, {{ props.who || 'world' }}!
Another cool thing you can do is use JSX **directly** - here’s an SVG element, used inline: .
```
_**Note**: destructuring imports must be quoted, but others need not be._
The above `mdx` file will produce the following module within Webpack;
```javascript
import React from 'react';
import PropTypes from 'prop-types';
import { name, version } from './package.json';
MarkdownComponent.propTypes = {
className: PropTypes.string,
style: PropTypes.object
};
MarkdownComponent['displayName'] = 'MarkdownComponentLoaderReadme';
function MarkdownComponent(props) {
const {className, style} = props;
return (
This is a Markdown Component file. Here you can include JSX-style assignment expressions; this component was generated using version { version } of { name }!
Props passed to this component are available as props, so you can embed those too! Hello there, { props.who || 'world' }!
Another cool thing you can do is use JSX directly - here’s an SVG element, used inline: .
);
};
export default MarkdownComponent;
```
You can then include it anywhere you like in your own React code;
```javascript
import ReactDOM from 'react-dom';
import Readme from './readme.mdx';
ReactDOM.render(
,
document.getElementById('main')
);
```
### Extra Configuration
Markdown Component Loader accepts configuration of options via the Webpack configuration file.
```javascript
module.exports = {
module: {
rules: [
{...more},
{
test: /\.mdx$/i,
use: [
'babel-loader',
{
loader: 'markdown-component-loader',
options: {...options}
}
]
}
]
},
{...more}
};
```
#### Available Options
* `passElementProps`: Controls whether props can be passed from the parent to the generated elements. Defaults to `false`.
* `implicitlyImportReact`: Whether to include React and PropTypes in the imports automatically. If set to `false`, you need to either supply React and PropTypes or import them explicitly. Defaults to `true`.
* `markdownItPlugins`: An array of [MarkdownIt plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin) (and optionally their additional arguments) to use within the markdown renderer. These can be specified either as instances, or as paths as returned by `require.resolve`.
##### MarkdownIt Plugins
If you supply an array of [MarkdownIt plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin) as `markdownItPlugins`, Markdown Component Loader will chain them into the internal MarkdownIt renderer.
```javascript
{
loader: 'markdown-component-loader',
options: {
markdownItPlugins: [
require('markdown-it-anchor'),
[require('markdown-it-table-of-contents'), { containerClass: 'my-container-class' }]
]
},
{...more}
}
```
The configuration above will supply both [`markdown-it-anchor`](https://www.npmjs.com/package/markdown-it-anchor) and [`markdown-it-table-of-contents`](https://www.npmjs.com/package/markdown-it-table-of-contents) to MarkdownIt's `use` method. `markdown-it-table-of-contents` is supplied within an array, and the entire array is passed as the arguments to `use`, allowing specifying plugin configurations.
###### Legacy Webpack compatibility
For compatibility with Webpack 1.x, where plugin configuration must be JSON compatible, plugins can be passed as path strings rather than the plugin object itself.
The equivalent of the example above in Webpack 1.x would be as follows.
```javascript
module.exports = {
markdownComponentLoader: {
markdownItPlugins: [
require.resolve('markdown-it-anchor'),
[require.resolve('markdown-it-table-of-contents'), { containerClass: 'my-container-class' }]
]
},
{...more}
};
```
### Styling and Interaction
#### Container Styling
The container will have supplied `className` and `style` props passed through to it.
#### Inner Element Styling
If `passElementProps` is set to `true`, elements within the Markdown Component can be styled on a per-element-name basis. You can set this in the `webpack.config.js` (see the "Extra Configuration" section).
All generated standard elements (read: elements which are known to `React.DOM`) will then have `elementProps['name']` spread onto them (where `name` is the tag name of the element). This option is intended to be used with [Basscss](http://www.basscss.com/) modular CSS.
Here's the above example markdown document converted with this option;
```javascript
import React from 'react';
import PropTypes from 'prop-types';
import { name, version } from './package.json';
MarkdownComponent.propTypes = {
className: PropTypes.string,
style: PropTypes.object,
elementProps: PropTypes.object
};
MarkdownComponent.defaultProps = {
elementProps: {}
};
MarkdownComponent['displayName'] = 'MarkdownComponentLoaderReadme';
function MarkdownComponent(props) {
const {className, style, elementProps} = props;
return (
This is a Markdown Component file. Here you can include JSX-style assignment expressions; this component was generated using version { version } of { name }!
Props passed to this component are available as props, so you can embed those too! Hello there, { props.who || 'world' }!
Another cool thing you can do is use JSX directly - here’s an SVG element, used inline: .
);
};
export default MarkdownComponent;
```
You can then specify _any_ prop you want here, and that prop will be applied to all elements of that tag name.
For example, if you wanted to get a callback from each level-1 heading instance, you could use the component like this;
```javascript
/* do something */
}
}}
/>
```
This also facilitates the Basscss style, allowing, for instance, styling of anchor tags like so;
```javascript
```
## Prior Art
[react-markdown-loader](https://github.com/javiercf/react-markdown-loader) by Javier Cubides allows use of React components within fenced code blocks (albeit not assignment expressions), and gave me the idea to use yaml front-matter for imports. Thanks! 😁