umi-plugin-md

KO | EN

gitlite — search

#python #ai #llm #go #golang #machine-learning #rust #deep-learning #docker #macos #nodejs #awesome-list #vue #open-source

(★ 16)

🍚 Markdown(*.md) component plugin for umi.

umi-plugin-md Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [umi-plugin-md](#) &middot; [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/chiaweilee/umi-plugin-md/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/umi-plugin-md.svg?style=flat)](https://www.npmjs.com/package/umi-plugin-md) [![npm downloads](https://img.shields.io/npm/dm/umi-plugin-md.svg)](https://npmcharts.com/compare/umi-plugin-md?minimal=true) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://raw.githubusercontent.com/chiaweilee/umi-plugin-md/master/)

Markdown(\*.md) component plugin for umi.

*Create your website with umi and markdown only. Convenient and powerful for blog, documentation site and GitBook.*

* **Convert markdown into component:** loaded by `markdown-it` and translate into React component.
* **Auto routes create:** auto create markdown routes from dir.
* **Auto anchor:** auto create anchor for `h1`, `h2` and `h3`.
* **XSS protect:** by [xss](https://www.npmjs.com/package/xss).
* **Support:** umi@2.x only

![Example](https://raw.githubusercontent.com/chiaweilee/umi-plugin-md/master/Screenshot%202019-07-08%20at%2021.15.41.png)

## Installation

```
npm install umi-plugin-md
```

## Demo

https://chiaweilee.github.io/umi-plugin-md/

## Usage

```js
// .umirc.js
export default {
  plugins: ['umi-plugin-md'],
};
```

## Options

**tips**: `route of markdown will have higher priority, so route might be covered.`

e.g, `index.md` will cover `index.jsx`.

## Anchor

![Example](https://raw.githubusercontent.com/chiaweilee/umi-plugin-md/master/Screenshot%202019-07-16%20at%2022.56.20.png)

#### Get anchor id?

```js
import { slug } from 'umi-plugin-md';

var text = $('h2').text();
var id = slug(text);
```

Or copy `umi-plugin-md/lib/helpers/slug.js` to your repo.

#### Anchor Stylize

```css
// global.css
@import "~umi-plugin-md/anchor.css";
```

Or, write yourself.

tips: we do not support `scroll to anchor on 'componentDidMount'` this moment.

## Markdown Stylize

[github-markdown-css](https://www.npmjs.com/package/github-markdown-css)

```css
// global.css
@import "~github-markdown-css/github-markdown.css";
@import "~highlight.js/styles/github.css";
```

```js
// .umirc.js
export default {
  plugins: [['umi-plugin-md', { className: 'markdown-body' }]],
};
```

## Priority

`index.md` have higher priority than `index.jsx`.

umi-plugin-md

umi-plugin-md Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

umi-plugin-md

umi-plugin-md Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README