showdown-highlight

A Showdown extension for highlight the code blocks.

This package uses highlight.js to highlight code blocks in Showdown output. :rocket:

:cloud: Installation

1# Using npm
2npm install --save showdown-highlight

3
4# Using yarn
5yarn add showdown-highlight

:clipboard: Example

1const showdown = require('showdown')
2    , showdownHighlight = require("showdown-highlight")
3    ;
4
5// After requiring the module, use it as extension
6let converter = new showdown.Converter({
7    // That's it
8    extensions: [showdownHighlight]
9});
10
11// Now you can Highlight code blocks
12let html = converter.makeHtml(`
13## Highlighting Code with Showdown
14
15Below we have a piece of JavaScript code:
16
17\`\`\`js
18function sayHello (msg, who) {
19    return \`\${who} says: msg\`;
20}
21sayHello("Hello World", "Johnny");
22\`\`\`
23`);
24
25console.log(html);
26// <h2 id="highlightingcodewithshowdown">Highlighting Code with Showdown</h2>
27//
28// <p>Below we have a piece of JavaScript code:</p>
29//
30// <pre><code class="js language-js"><span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">sayHello</span> (<span class="hljs-params">msg, who</span>) </span>{
31//     <span class="hljs-keyword">return</span> <span class="hljs-string">`<span class="hljs-subst">${who}</span> says: msg`</span>;
32// }
33// sayHello(<span class="hljs-string">"Hello World"</span>, <span class="hljs-string">"Johnny"</span>);
34// </code></pre>

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• mdpdf
• bloggify-markdown-highlight
• @kev_nz/publisher
• md-toy-blog
• markdown2dash
• ember-showdown-highlight
• trumpdoc
• md-srv
• md-browse
• showit
• chimpsky
• showdown-html
• callete
• swanky
• tutors-html
• @etermind/alex

:scroll: License

MIT © Bloggify