mirror of https://github.com/showdownjs/showdown
51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
# Showdown documentation
|
|
|
|
![Showdown][sd-logo]
|
|
|
|
|
|
|
|
[](http://badge.fury.io/js/showdown)
|
|
[](http://badge.fury.io/bo/showdown)
|
|
[](https://gitter.im/showdownjs/showdown?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://www.paypal.me/tiviesantos)
|
|
|
|
Showdown is a JavaScript Markdown to HTML converter, based on the original works by John Gruber.
|
|
Showdown can be used on the client-side (in the browser) or server-side (with Node.js).
|
|
|
|
----
|
|
|
|
## Live demo
|
|
|
|
<http://demo.showdownjs.com/>
|
|
|
|
## Who uses Showdown (or a fork)
|
|
|
|
* [Antmarky](https://github.com/bandantonio/antmarky)
|
|
* [GoogleCloudPlatform](https://github.com/GoogleCloudPlatform)
|
|
* [Meteor](https://www.meteor.com/)
|
|
* [StackExchange](http://stackexchange.com/) - forked as [PageDown](https://code.google.com/p/pagedown/)
|
|
* [docular](https://github.com/Vertafore/docular)
|
|
* [md-page](https://github.com/oscarmorrison/md-page)
|
|
* [QCObjects](https://qcobjects.dev)
|
|
* [and some others](https://www.npmjs.com/browse/depended/showdown)
|
|
|
|
## Installation
|
|
|
|
To install Showdown, follow the instructions from the [Quickstart guide](quickstart.md).
|
|
|
|
|
|
## License
|
|
|
|
ShowdownJS v 2.0 is release under the MIT version.
|
|
|
|
Previous versions are release under BSD.
|
|
|
|
[sd-logo]: https://raw.githubusercontent.com/showdownjs/logo/master/dist/logo.readme.png
|
|
[wiki]: https://github.com/showdownjs/showdown/wiki
|
|
[cli-wiki]: https://github.com/showdownjs/showdown/wiki/CLI-tool
|
|
[definitely-typed]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/showdown
|
|
[xss-wiki]: https://github.com/showdownjs/showdown/wiki/Markdown's-XSS-Vulnerability-(and-how-to-mitigate-it)
|
|
[ext-wiki]: https://github.com/showdownjs/showdown/wiki/extensions
|
|
[coding-rules]: https://github.com/showdownjs/code-style/blob/master/README.md
|
|
[ng-commit-guide]: https://github.com/showdownjs/code-style/blob/master/README.md#commit-message-convention
|
|
[boilerplate-repo]: https://github.com/showdownjs/extension-boilerplate |