utility showdown

webutilz/showdown

A Markdown to HTML converter written in Javascript

, _(*1)

, _(*2)

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)., _(*3)

Live DEMO

Check a live Demo here http://showdownjs.github.io/demo/, _(*4)

Installation

Download tarball

You can download the latest release tarball directly from releases, _(*5)

Bower

bower install showdown

npm (server-side)

npm install showdown

CDN

You can also use one of several CDNs available:, _(*6)

• github CDN, _(*7)

  https://cdn.rawgit.com/showdownjs/showdown/<version tag>/dist/showdown.min.js

• cdnjs, _(*8)

  https://cdnjs.cloudflare.com/ajax/libs/showdown/<version tag>/showdown.min.js

Browser Compatibility

Showdown has been tested successfully with:, _(*9)

• 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., _(*10)

Node compatibility

Showdown has been tested with node 0.8 and 0.10. However, it should work with previous versions, such as node 0.6., _(*11)

Legacy version

If you're looking for showdown v<1.0.0, you can find it in the legacy branch., _(*12)

Changelog

You can check the full changelog, _(*13)

Extended documentation

Check our wiki pages for examples and a more in-depth documentation., _(*14)

Quick Example

Node

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

Browser

var converter = new showdown.Converter(),
    text      = '#hello, markdown!',
    html      = converter.makeHtml(text);

Output

Both examples should output..., _(*15)

<h1 id="hellomarkdown">hello, markdown!</h1>

Options

You can change some of showdown's default behavior through options., _(*16)

Setting options

Options can be set:, _(*17)

Globally

Setting a "global" option affects all instances of showdown, _(*18)

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

Locally

Setting a "local" option only affects the specified Converter object. Local options can be set:, _(*19)

• through the constructor, _(*20)

  var converter = new showdown.Converter({optionKey: 'value'});
  

• through the setOption() method, _(*21)

  var converter = new showdown.Converter();
  converter.setOption('optionKey', 'value');
  

Getting an option

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

getOption()

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

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

getOptions()

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

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

Retrieve the default options

You can get showdown's default options with:, _(*23)

var defaultOptions = showdown.getDefaultOptions();

Valid Options

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

  This:, _(*25)

  <code><pre>var foo = 'bar';
  </pre></code>
  

  Becomes this:, _(*26)

  <code><pre>var foo = 'bar';</pre></code>
  

• noHeaderId: (boolean) [default false] Disable the automatic generation of header ids. Setting to true overrides prefixHeaderId, _(*27)

• 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., _(*28)

• parseImgDimensions: (boolean) [default false] Enable support for setting image dimensions from within markdown syntax. Examples:, _(*29)

  ![foo](foo.jpg =100x80)     simple, assumes units are in px
  ![bar](bar.jpg =100x*)      sets the height to "auto"
  ![baz](baz.jpg =80%x5em)  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, _(*30)

  # foo
  

  will be parsed as, _(*31)

  <h3>foo</h3>
  

• simplifiedAutoLink: (boolean) [default false] Turning this on will enable GFM autolink style. This means that, _(*32)

  some text www.google.com
  

  will be parsed as ````, _(*33)

<, _(*34)

p>some text www.google.com ```, _(*35)

• literalMidWordUnderscores: (boolean) [default false] Turning this on will stop showdown from interpreting underscores in the middle of words as <em> and <strong> and instead treat them as literal underscores., _(*36)

  Example:, _(*37)

  some text with__underscores__in middle
  

  will be parsed as, _(*38)

  <p>some text with__underscores__in middle</p>
  

• strikethrough: (boolean) [default false] Enable support for strikethrough syntax. ~~strikethrough~~ as <del>strikethrough</del>, _(*39)

• tables: (boolean) [default false] Enable support for tables syntax. Example:, _(*40)

  | h1    |    h2   |      h3 |
  |:------|:-------:|--------:|
  | 100   | [a][1]  | ![b][2] |
  | *foo* | **bar** | ~~baz~~ |
  

  See the wiki for more info, _(*41)

• tablesHeaderId: (boolean) [default false] If enabled adds an id property to table headers tags., _(*42)

• ghCodeBlocks: (boolean) [default true] Enable support for GFM code block style., _(*43)

• tasklists:(boolean) [default false] Enable support for GFM takslists. Example:, _(*44)

  - [x] This task is done
  - [ ] This is still pending
  

• smoothLivePreview: (boolean) [default false] Prevents weird effects in live previews due to incomplete input

CLI Tool

Showdown also comes bundled with a Command Line Interface tool. You can check the CLI wiki page for more info, _(*45)

Integration with AngularJS

ShowdownJS project also provides seamlessly integration with AngularJS via a "plugin". Please visit https://github.com/showdownjs/ngShowdown for more information., _(*46)

Integration with TypeScript

If you're using TypeScript you maybe want to use the types from DefinitelyTyped, _(*47)

XSS vulnerability

Showdown doesn't sanitize the input. This is by design since markdown relies on it to allow certain features to be correctly parsed into HTML. This, however, means XSS injection is quite possible., _(*48)

Please refer to the wiki article Markdown's XSS Vulnerability (and how to mitigate it) for more information., _(*49)

Extensions

Showdown allows additional functionality to be loaded via extensions. (you can find a list of known showdown extensions here), _(*50)

Client-side Extension Usage

var converter = new showdown.Converter({ extensions: 'twitter' });

Server-side Extension Usage

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

Tests

A suite of tests is available which require node.js. Once node is installed, run the following command from the project root to install the dependencies:, _(*51)

npm install

Once installed the tests can be run from the project root using:, _(*52)

npm test

New test cases can easily be added. Create a markdown file (ending in .md) which contains the markdown to test. Create a .html file of the exact same name. It will automatically be tested when the tests are executed with mocha., _(*53)

Contributing

If you wish to contribute please read the following quick guide., _(*54)

Want a Feature?

You can request a new feature by submitting an issue. If you would like to implement a new feature feel free to issue a Pull Request., _(*55)

Pull requests (PRs)

PRs are awesome. However, before you submit your pull request consider the following guidelines:, _(*56)

• Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

• When issuing PRs that change code, make your changes in a new git branch based on master:, _(*57)

  git checkout -b my-fix-branch master
  

• Documentation (i.e: README.md) changes can be made directly against master., _(*58)

• Run the full test suite before submitting and make sure all tests pass (obviously =P).
• Try to follow our coding style rules. Breaking them prevents the PR to pass the tests.
• Refrain from fixing multiple issues in the same pull request. It's preferable to open multiple small PRs instead of one hard to review big one.
• If the PR introduces a new feature or fixes an issue, please add the appropriate test case.
• We use commit notes to generate the changelog. It's extremely helpful if your commit messages adhere to the AngularJS Git Commit Guidelines.

• If we suggest changes then:, _(*59)

  • Make the required updates.
  • Re-run the Angular test suite to ensure tests are still passing.
  • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

  git rebase master -i
  git push origin my-fix-branch -f
  

• After your pull request is merged, you can safely delete your branch.

If you have time to contribute to this project, we feel obliged that you get credit for it. These rules enable us to review your PR faster and will give you appropriate credit in your GitHub profile. We thank you in advance for your contribution!, _(*60)

Joining the team

We're looking for members to help maintaining Showdown. Please see this issue to express interest or comment on this note., _(*61)

Credits

Full credit list at https://github.com/showdownjs/showdown/blob/master/CREDITS.md, _(*62)

Showdown is powered by:br/ , _(*63)