Skip to content

Latest commit

 

History

History
55 lines (45 loc) · 1.15 KB

markdown.md

File metadata and controls

55 lines (45 loc) · 1.15 KB

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

Even 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>

mermaid.initialize({ startOnLoad: false });

window.$docsify = {
  markdown: {
    renderer: {
      code: function(code, lang) {
        if (lang === "mermaid") {
          return (
            '<div class="mermaid">' + mermaid.render(lang, code) + "</div>"
          );
        }
        return this.origin.code.apply(this, arguments);
      }
    }
  }
}