dragonbabyi / showdown Goto Github PK

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).

You can download the latest release tarball directly from https://github.com/showdownjs/showdown/releases

bower install showdown

npm install showdown

Showdown has been tested successfully with:

• Firefox 1.5 and 2.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.

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

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

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

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

Both examples should output...

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

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

Options can be set:

Setting a "global" option affects all instances of showdown

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

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

• through the constructor

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

• through the setOption() method

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

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

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

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

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

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

• omitExtraWLInCodeBlocks: (boolean) Omits the trailing newline in a code block. Ex:

  This:

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

  Becomes this:

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

• prefixHeaderId: (string/boolean) Adds 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.

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

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

<script src="showdown.js" />
<script src="twitter-extension.js" />

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

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

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 development dependencies:

npm install --dev

Once installed the tests can be run from the project root using:

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.

If you wish to contribute please read the following quick guide.

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.

PRs are awesome. However, before you submit your pull request consider the following guidelines:

• 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:

  git checkout -b my-fix-branch master

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

• 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:

  • 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!

We're looking for members to help maintaining Showdown. Please see this issue to express interest or comment on this note.

Full credit list at https://github.com/showdownjs/showdown/blob/master/CREDITS.md

Showdown is powered by: