![Showdown][sd-logo]

!Build Status: Linux

------

Showdown is a Javascript Markdown to HTML converter, based on the original works by John Gruber.
Showdown can be used client side (in the browser) or server side (with NodeJs).

Live DEMO

Check a live Demo here http://demo.showdownjs.com/

Funding

As you know, ShowdownJS is a free library and it will remain free forever. However, maintaining and improving the library costs time and money.

If you like our work and find our library useful, please donate through paypal!!
Your contribution will be greatly appreciated and help us continue to develop this awesome library.

License

ShowdownJS v 2.0 is release under the MIT version.
Previous versions are release under BSD.

Who uses Showdown (or a fork)

- GoogleCloudPlatform
- Meteor
- Stackexchange - forked as PageDown
- docular
- md-page
- QCObjects
- and some others...

Installation

$3

You can download the latest release tarball directly from [releases][releases]

$3

bower install showdown

$3

npm install showdown

$3

PM> Install-Package showdownjs

The NuGet Packages can be found here.

$3

You can also use one of several CDNs available:

* jsDelivr

https://cdn.jsdelivr.net/npm/showdown@/dist/showdown.min.js

* cdnjs

https://cdnjs.cloudflare.com/ajax/libs/showdown//showdown.min.js

* unpkg

https://unpkg.com/showdown/dist/showdown.min.js

Note: replace with an actual full length version you're interested in e.g. 1.9.0

Browser Compatibility

Showdown has been tested successfully with:

* Firefox 1.5 and 2.0
* Chrome 12.0
* Internet Explorer 6 and 7
* Safari 2.0.4
* Opera 8.54 and 9.10
* Netscape 8.1.2
* Konqueror 3.5.4

In theory, Showdown will work in any browser that supports ECMA 262 3rd Edition (JavaScript 1.5).
The converter itself might even work in things that aren't web browsers, like Acrobat. No promises.

Node compatibility

Showdown supports node versions in the "Current", "Active" and "Maintenance" phases. Currently this includes Node 12.x, 14.x, 16.x and 17.x. See the node release roadmap for more details.

Other versions of node may likely work, but they are not tested regularly.

Pervious versions

If you're looking for showdown v<1.0.0, you can find it in the [legacy branch][legacy-branch].

If you are looking for showdown 1.* you can find it in the [version_1.x][version_1.x] branch.

Changelog

You can check the full [changelog][changelog]

Extended documentation

Quick Example

$3

Markdown to HTML
``js
var showdown = require('showdown'),
converter = new showdown.Converter(),
text = '# hello, markdown!',
html = converter.makeHtml(text);
`

HTML to Markdown
`js
var showdown = require('showdown'),
converter = new showdown.Converter(),
html = 'Please Support us!',
md = converter.makeMarkdown(text);
`

$3

`js
var converter = new showdown.Converter(),
html = converter.makeHtml('# hello, markdown!'),
md = converter.makeMd('Please Support us!');
`

$3

Both examples should output...

`html


hello, markdown!

`md
Please Support us!
`

Options

You can change some of showdown's default behavior through options.

$3

Options can be set:

#### Globally

Setting a "global" option affects all instances of showdown

`js
showdown.setOption('optionKey', 'value');
`

#### Locally
Setting a "local" option only affects the specified Converter object.
Local options can be set:

* through the constructor
`js
var converter = new showdown.Converter({optionKey: 'value'});
`

* through the setOption() method
`js
var converter = new showdown.Converter();
converter.setOption('optionKey', 'value');
`

$3

Showdown provides 2 methods (both local and global) to retrieve previous set options.

#### getOption()

`js
// Global
var myOption = showdown.getOption('optionKey');

//Local
var myOption = converter.getOption('optionKey');
`

#### getOptions()

`js
// Global
var showdownGlobalOptions = showdown.getOptions();

//Local
var thisConverterSpecificOptions = converter.getOptions();
`

$3

You can get showdown's default options with:
`js
var defaultOptions = showdown.getDefaultOptions();
`

$3

* omitExtraWLInCodeBlocks: (boolean) [default false] Omit the trailing newline in a code block. Ex:

This:
`html


var foo = 'bar';
    

var foo = 'bar';

* customizedHeaderId: (boolean) [default false] Use text in curly braces as header id. (since v1.7.0)
Example:
`
## Sample header {real-id} will use real-id as id
`

* ghCompatibleHeaderId: (boolean) [default false] Generate header ids compatible with github style
(spaces are replaced with dashes and a bunch of non alphanumeric chars are removed) (since v1.5.5)

* prefixHeaderId: (string/boolean) [default false] Add a prefix to the generated header ids.
Passing a string will prefix that string to the header id. Setting to true will add a generic 'section' prefix.

* rawPrefixHeaderId: (boolean) [default false] Setting this option to true will prevent showdown from modifying the prefix.
This might result in malformed IDs (if, for instance, the " char is used in the prefix).
Has no effect if prefixHeaderId is set to false. (since v 1.7.3)

* rawHeaderId: (boolean) [default false] Remove only spaces, ' and " from generated header ids (including prefixes),
replacing them with dashes (-). WARNING: This might result in malformed ids (since v1.7.3)

* parseImgDimensions: (boolean) [default false] Enable support for setting image dimensions from within markdown syntax.
Examples:
`
!foo simple, assumes units are in px
!bar sets the height to "auto"
!baz Image with width of 80% and height of 5em
`

* headerLevelStart: (integer) [default 1] Set the header starting level. For instance, setting this to 3 means that

`md
# foo
`
will be parsed as

`html


foo

`md
some text www.google.com
`
will be parsed as
`html


some text www.google.com
`

* excludeTrailingPunctuationFromURLs: (boolean) [default false] This option excludes trailing punctuation from autolinking urls.
Punctuation excluded: . ! ? ( ). Only applies if simplifiedAutoLink option is set to true.

`md
check this link www.google.com!
`
will be parsed as
`html


check this link www.google.com!