mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-12 12:16:09 +08:00
a72e7490c3
Please makes sure these boxes are checked before submitting your PR, thank you! * [x] Make sure you are merging your commits to `master` branch. * [x] Add some descriptions and refer relative issues for you PR. * [x] DO NOT include files inside `lib` directory.
57 lines
1.2 KiB
Markdown
57 lines
1.2 KiB
Markdown
# Markdown configuration
|
|
|
|
**docsify** uses [marked](https://github.com/markedjs/marked) as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing `renderer`:
|
|
|
|
```js
|
|
window.$docsify = {
|
|
markdown: {
|
|
smartypants: true,
|
|
renderer: {
|
|
link: function() {
|
|
// ...
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
?> Configuration Options Reference [marked documentation](https://marked.js.org/#/USING_ADVANCED.md)
|
|
|
|
Even you can completely customize the parsing rules.
|
|
|
|
```js
|
|
window.$docsify = {
|
|
markdown: function(marked, renderer) {
|
|
// ...
|
|
|
|
return marked
|
|
}
|
|
}
|
|
```
|
|
|
|
## Supports mermaid
|
|
|
|
```js
|
|
// Import mermaid
|
|
// <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.css">
|
|
// <script src="//cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
|
|
var num = 0;
|
|
mermaid.initialize({ startOnLoad: false });
|
|
|
|
window.$docsify = {
|
|
markdown: {
|
|
renderer: {
|
|
code: function(code, lang) {
|
|
if (lang === "mermaid") {
|
|
return (
|
|
'<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + "</div>"
|
|
);
|
|
}
|
|
return this.origin.code.apply(this, arguments);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|