https://github.com/nashaofu/markdown365-parser

A markdown parser library base vnode
https://github.com/nashaofu/markdown365-parser

markdown markdown-parser vdom vnode

Last synced: 2 months ago
JSON representation

A markdown parser library base vnode

• Host: GitHub
• URL: https://github.com/nashaofu/markdown365-parser
• Owner: nashaofu
• License: mit
• Created: 2018-01-21T05:58:50.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-04-22T13:52:49.000Z (over 2 years ago)
• Last Synced: 2024-10-11T04:12:04.328Z (3 months ago)
• Topics: markdown, markdown-parser, vdom, vnode
• Language: JavaScript
• Homepage: https://nashaofu.github.io/markdown365-parser/
• Size: 2.41 MB
• Stars: 10
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# markdown365-parser

A markdown parser library base vnode

基于vnode的markdown解析器。markdown语法解析由[marked](https://github.com/chjj/marked)扩展而来，示例地址[Github Pages](https://nashaofu.github.io/markdown365-parser/)

## Install

[![NPM](https://nodei.co/npm/markdown365-parser.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/markdown365-parser/)

## Usage

### Browser

```html

  

  markdown365-parser

  

  


  

    const markdwon = '## markdown365-parser'

    const parser = new Markdown365Parser({

      gfm: true,

      tables: true,

      breaks: true,

      pedantic: false,

      smartypants: false,

      base: '',

      $el: document.querySelector('#previiew')

    })

    parser.parse(markdown)

  


```

## 支持语法

支持语法请查看[Grammar](./Grammar.md)或者[Github Pages](https://nashaofu.github.io/markdown365-parser/)

## Options

* **gfm**: GitHub flavored markdown语法支持. 默认: `true`

* **tables**: GFM tables语法支持. 必须要求`gfm`为`true`. 默认: `true`

* **breaks**: GFM line breaks解析规则支持. 必须要求`gfm`为`true`. 默认: `false`

* **pedantic**: 是否尽可能遵守`markdown.pl`的部分内容. 不去掉一些不严格的内容. 默认: `false`

* **smartypants**: 是否替换特殊符号. 默认: `false`

* **base**：这里是用来指定markdwon文档中的链接地址、图片地址的前置链接，如markdown中的说有图片都指向另一个域的时候，base就可以设置为指定域名。这里这个参数主要时考虑到编写桌面markdown编辑器用的，因为编辑器打开markdown文件时，对应的图片的路径要转换为相对markdown文件所在目录的相对路径，具体可参考我的另一个项目[markdown365](https://github.com/nashaofu/markdown365)

* **$el**：文档要渲染到的dom节点

## Screenshots

1. 编辑模式下![editor.png](./screenshots/editor.png)

2. 与marked对比![compare.png](./screenshots/compare.png)

## Licences

[MIT](./LICENSE)