mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-11-30 02:58:37 +08:00
97806cb757
While referencing the documentation, I noticed a few phrases that could be changed to sound more natural. I tried to keep the original meanings.
1.2 KiB
1.2 KiB
Markdown configuration
docsify uses marked as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing renderer
:
window.$docsify = {
markdown: {
smartypants: true,
renderer: {
link: function() {
// ...
}
}
}
}
?> Configuration Options Reference: marked documentation
You can completely customize the parsing rules.
window.$docsify = {
markdown: function(marked, renderer) {
// ...
return marked
}
}
Supports mermaid
// 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);
}
}
}
}