1.0.2 • Published 1 year ago

rollup-plugin-mdm v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

rollup-plugin-mdm

Import markdown module for rollup & vite.

Usage

npm i -D rollup-plugin-mdm

rollup.config.js

const mdm = require('rollup-plugin-mdm');

module.exports = {
  plugins: [
    mdm()
  ]
}

use github css:

npm i github-markdown-css

import as html

  • input
export { default as html } from './test.md';
  • output
import 'github-markdown-css/github-markdown-light.css';

var test = `<div class="markdown-body">
<h2>Title</h2>
<p>description…</p>
</div>`;

export { test as html };

import as react

  • input
export { default as react } from './test.md?react';
  • output
import 'github-markdown-css/github-markdown-light.css';
import { createElement } from 'react';

function test$1() {
  return createElement(
    'div', 
    { 
      className: 'markdown-body',
      dangerouslySetInnerHTML: {
        __html: `<h2>Title</h2>
<p>description…</p>`
      }
    }
  );
}

export { test$1 as react };

import as vue

  • input
export { default as vue } from './test.md?vue';
  • output
import 'github-markdown-css/github-markdown-light.css';

var test = {
  render(h) {
    h('div', {
      class: 'markdown-body',
      domProps: {
        innerHTML: `<h2>Title</h2>
<p>description…</p>`
      }
    });
  }
};

export { test as vue };

Options

Inherit from markdown-it#Options.

  • codeTheme

Inherit from shiki/themes

export type Theme =
  | 'css-variables'
  | 'dark-plus'
  | 'dracula-soft'
  | 'dracula'
  | 'github-dark-dimmed'
  | 'github-dark'
  | 'github-light'
  | 'hc_light'
  | 'light-plus'
  | 'material-darker'
  | 'material-default'
  | 'material-lighter'
  | 'material-ocean'
  | 'material-palenight'
  | 'min-dark'
  | 'min-light'
  | 'monokai'
  | 'nord'
  | 'one-dark-pro'
  | 'poimandres'
  | 'rose-pine-dawn'
  | 'rose-pine-moon'
  | 'rose-pine'
  | 'slack-dark'
  | 'slack-ochin'
  | 'solarized-dark'
  | 'solarized-light'
  | 'vitesse-dark'
  | 'vitesse-light'
  • className

The container class name, default is markdown-body (github css).

  • injectStyle

Inject markdown style, default is 'github-markdown-css/github-markdown-light.css', set false remove it.

Type shims

Includes shims file to your tsconfig.json.

{
  "include": [
    "node_modules/rollup-plugin-mdm/shims-html.d.ts",
    "node_modules/rollup-plugin-mdm/shims-react.d.ts",
    "node_modules/rollup-plugin-mdm/shims-vue.d.ts"
  ]
}