Skip to content

Latest commit

 

History

History
57 lines (47 loc) · 1.17 KB

markdown.md

File metadata and controls

57 lines (47 loc) · 1.17 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

You can completely customize the parsing rules.

window.$docsify = {
  markdown: function(marked, renderer) {
    // ...

    return marked;
  },
};

Supports mermaid

// First include mermaid in your page with:
//   <script src="//cdn.jsdelivr.net/npm/[email protected]/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);
      },
    },
  },
};