Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BuptStEve/markdown-it-vuese
đ Vuese plugin for markdown-it markdown parser
https://github.com/BuptStEve/markdown-it-vuese
documentation markdown markdown-it markdown-plugin vuese
Last synced: about 2 months ago
JSON representation
đ Vuese plugin for markdown-it markdown parser
- Host: GitHub
- URL: https://github.com/BuptStEve/markdown-it-vuese
- Owner: BuptStEve
- License: mit
- Created: 2019-01-25T15:19:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-11T13:31:06.000Z (almost 5 years ago)
- Last Synced: 2024-07-20T01:16:29.018Z (2 months ago)
- Topics: documentation, markdown, markdown-it, markdown-plugin, vuese
- Language: JavaScript
- Homepage: https://buptsteve.github.io/markdown-it-vuese
- Size: 476 KB
- Stars: 16
- Watchers: 1
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
markdown-it-vuese
English | įŽäŊä¸æ
> [Vuese][1] plugin for [markdown-it][2] markdown parser.
With this plugin, you can use [Vuese][1] to automatically generate documents while importing existing `*.vue` files via following syntax.
```md
<[vuese](@/filePath)
```
> The default value of @ is `process.cwd()`.
Please click here to see the demo
## Install
```bash
$ npm i -S markdown-it-vuese
# OR
$ yarn add markdown-it-vuese
```
## Usage
```js
const md = require('markdown-it')()
.use(require('markdown-it-vuese') [, options])
```
## Options
```js
const md = require('markdown-it')()
.use(require('markdown-it-vuese'), {
root: 'some path',
vueseRe: /your regexp/,
useParser: parserRes => parserRes.name,
useRender: (vueseRender) => {
const renderRes = vueseRender.render()
const markdownRes = vueseRender.renderMarkdown()
return 'something'
},
useAll: ({ ... }) => {
return 'something'
},
})
```
### root
* Type: `String`
* Default: `process.cwd()`
Root Directory, this value will replace the @ in file path.
### vueseRe
* Type: `RegExp`
* Default: `/<\[vuese\]\((.+)\)/i`
Regular expression, you can customize it as you like.
### ruleName
* Type: `String`
* Default: `vuese`
Rule name, it will be used by [markdown-it][2], so be careful not to duplicate [existing rules][9].
Use it with `vueseRe`, we can use different rules in the same document to render different results.
```js
const vuese = require('markdown-it-vuese')
const md = require('markdown-it')()
// default
// <[vuese](filePath)
.use(vuese)
// <[vuese-h3](filePath)
// No title, `Props` and other attributes should be changed from `
` to ``
.use(vuese, {
vueseRe: /<\[vuese-h3\]\((.+)\)/i,
ruleName: 'vuese-h3',
useRender: (vueseRender) => {
const renderRes = vueseRender.render()
const genMd = key => `### ${key}\n${renderRes[key]}\n`
return Object.keys(renderRes).map(genMd).join('')
},
})
```
### useParser
* Type: `Function`
* Default: `null`
It takes [@vuese/parser `ParserResult`][7] as a parameter.
If `useParser` exists, it returns the result directly after running, otherwise try running `useRender`.
### useRender
* Type: `Function`
* Default: `null`
It takes [@vuese/markdown-render `Render Class`][8] as a parameter.
If `useRender` exists, it returns the result directly after running, otherwise try running `useAll`.
For example, you can call the following methods to generate objects and markdown documents, respectively.
* `render`: will generate `renderRes`
* `renderMarkdown`: will generate `markdownRes`
### useAll
* Type: `Function`
* Default: `null`
It takes an object as parameters with there attributes: `content`(source file content), `parserRes`, `renderRes`, `markdownRes`.
Return `markdownRes.content` by default, if `useAll` does not exist.
```js
const md = require('markdown-it')()
.use(require('markdown-it-vuese'), {
useAll: ({
content,
parserRes,
renderRes,
markdownRes,
}) => {
return 'something'
},
})
```
### parserOptions
* Type: `Object`
* Default: `{}`
It passes [@vuese/parser options][5]
### renderOptions
* Type: `Object`
* Default: `{}`
It passes [@vuese/markdown-render options][6]
## License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) [StEve Young](https://github.com/BuptStEve)
[1]: https://github.com/vuese/vuese
[2]: https://github.com/markdown-it/markdown-it
[3]: https://vuese.org/parser/
[4]: https://vuese.org/markdown-render/
[5]: https://vuese.org/parser/#parseroptions
[6]: https://vuese.org/markdown-render/#renderoptions
[7]: https://vuese.org/parser/#parserresult
[8]: https://vuese.org/markdown-render/#render-class
[9]: https://markdown-it.github.io/markdown-it/#Renderer.prototype.rules