showdown-prettify

Prettify extension for Showdown.js

Showing:

Popularity

Downloads/wk

183

GitHub Stars

17

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

1

Size (min+gzip)

24.4KB

License

BSD-2-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Showdown's Prettify Extension

Build Status npm version npm version


An extension to add Google Prettify hints to showdown's HTML output

Installation

With npm

npm install showdown-prettify

With bower

bower install showdown-prettify

Manual

You can also download the latest release zip or tarball and include it in your webpage, after showdown:

<script src="showdown.min.js">
<script src="showdown-prettify.min.js">

Enabling the extension

After including the extension in your application, you just need to enable it in showdown.

var converter = new showdown.Converter({extensions: ['prettify']});

Example

var converter = new showdown.Converter({extensions: ['prettify']}),
    input = "Here's a simple hello world in javascript:\n" +
            "\n" +
            "    alert('Hello World!');\n" +
            "\n" +
            "The `alert` function is a build-in global from `window`.";
    html = converter.makeHtml(input);
    console.log(html);

This should output the equivalent to:

<p>Here's a simple hello world in javascript:</p>

<pre class="prettyprint linenums" tabIndex="0"><code data-inner="1">alert('Hello World!');
</code></pre>

<p>The <code class="prettyprint">alert</code> function is a build-in global from <code class="prettyprint">window</code>.</p>

License

These files are distributed under BSD license. For more information, please check the LICENSE file in the source code.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100