https://github.com/dwqs/mpvue-markdown-parser

A markdown parser for mpvue
https://github.com/dwqs/mpvue-markdown-parser

markdown mpvue mpvue-markdown mpvue-markdown-parser wx wx-markdown wx-markdown-parser

Last synced: about 1 month ago
JSON representation

A markdown parser for mpvue

• Host: GitHub
• URL: https://github.com/dwqs/mpvue-markdown-parser
• Owner: dwqs
• License: mit
• Archived: true
• Created: 2018-06-25T17:13:23.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-17T11:30:43.000Z (over 6 years ago)
• Last Synced: 2025-03-04T23:35:09.466Z (about 2 months ago)
• Topics: markdown, mpvue, mpvue-markdown, mpvue-markdown-parser, wx, wx-markdown, wx-markdown-parser
• Language: JavaScript
• Size: 17.6 KB
• Stars: 9
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mpvue - mpvue-markdown-parser - A markdown parser for mpvue (组件 / 目录)

README

        
![npm-version](https://img.shields.io/npm/v/mpvue-markdown-parser.svg) ![license](https://img.shields.io/npm/l/mpvue-markdown-parser.svg)

## mpvue-markdown-parser

A markdown parser for [mpvue](https://github.com/Meituan-Dianping/mpvue).

## Preview screenshots

**Basic render:**

![image](https://user-images.githubusercontent.com/7871813/41890957-a8bf550e-7944-11e8-95c5-188e480d93ed.png)

**Code highlight and list:**

![image](https://user-images.githubusercontent.com/7871813/41891003-db5ed8f4-7944-11e8-8409-2a5bedd736e1.png)

**Table and tasks lists:**

![image](https://user-images.githubusercontent.com/7871813/41891028-f7d1896e-7944-11e8-8d86-c05a427c8c05.png)

## Features

1. Easy to use

2. Supports code highlight, [tasks list](https://blog.github.com/2014-04-28-task-lists-in-all-markdown-documents/), etc.

3. Powered by native component(`rich-text`)

4. Better Performance

## Installation

npm:

```

npm i --save mpvue-markdown-parser

```

or yarn

```

yarn add  mpvue-markdown-parser

```

## Get Started

```html

  

  import 'prismjs/themes/prism.css';

  import MpvueMarkdownParser from 'mpvue-markdown-parser';

  import 'mpvue-markdown-parser/dist/index.css';

  export default {

    data () {

      return {

        nodes: MpvueMarkdownParser('# your markdown text')

      }

    }

  }

```

## Used By

* [mpvue-jithub](https://github.com/dwqs/mp-jithub)

## LICENSE

MIT