npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

showdown-highlight

2.1.3 • Public • Published

showdown-highlight

Version Downloads

A Showdown extension for highlight the code blocks.

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

☁️ Installation

# Using npm 
npm install --save showdown-highlight
 
# Using yarn 
yarn add showdown-highlight

📋 Example

const showdown = require('showdown')
    , showdownHighlight = require("showdown-highlight")
    ;
 
// After requiring the module, use it as extension
let converter = new showdown.Converter({
    // That's it
    extensions: [showdownHighlight]
});
 
// Now you can Highlight code blocks
let html = converter.makeHtml(`
## Highlighting Code with Showdown
 
Below we have a piece of JavaScript code:
 
\`\`\`js
function sayHello (msg, who) {
    return \`\${who} says: msg\`;
}
sayHello("Hello World", "Johnny");
\`\`\`
`);
 
console.log(html);
// <h2 id="highlightingcodewithshowdown">Highlighting Code with Showdown</h2>
//
// <p>Below we have a piece of JavaScript code:</p>
//
// <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>{
//     <span class="hljs-keyword">return</span> <span class="hljs-string">`<span class="hljs-subst">${who}</span> says: msg`</span>;
// }
// sayHello(<span class="hljs-string">"Hello World"</span>, <span class="hljs-string">"Johnny"</span>);
// </code></pre>

❓ 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. 🐛

😋 How to contribute

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

💫 Where is this library used?

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

  • bloggify-markdown-highlight (by Bloggify)—Highlight code blocks in the Markdown code.
  • ember-showdown-highlight—The default blueprint for ember-cli addons.
  • markdown2dash (by Bob)—Convert markdown files to Dash docset in CLI
  • md-srv (by aikei)—a simple server, converting served .md files to html
  • swanky (by Rod Leviton)—A simple, flexible and powerful tool for creating beautiful documentation.
  • trumpdoc—# Features - 😄 Suuuupppper easy to build. Do not need any shiz to build.(such as webpack) - 👍 Simple and powerful, pure React application - 😈 Manage your documentation like a president - 📄 code-block styles

📜 License

MIT © Bloggify

install

npm i showdown-highlight

Downloadsweekly downloads

708

version

2.1.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability