mirror of
https://github.com/showdownjs/showdown.git
synced 2024-03-22 13:30:55 +08:00
78 lines
2.9 KiB
Markdown
78 lines
2.9 KiB
Markdown
![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)
|
|
|
|
## Quickstart
|
|
|
|
Check our documentation for the [quickstart guide][quickstart]
|
|
and possible [installation methods][installation-methods].
|
|
|
|
## Showdown features
|
|
|
|
### Platform-agnostic
|
|
|
|
Showdown can easily be used on server-side and client-side.
|
|
|
|
### Two-way conversion
|
|
|
|
Showdown not only helps you to convert your Markdown documents into HTML but also can bring them back to Markdown from HTML.
|
|
|
|
### Extensions
|
|
|
|
Expand Showdown's functionality using a powerful [extension system][extensions]. Extensions can also be used on server-side and client-side.
|
|
|
|
### CLI
|
|
|
|
Showdown comes bundled with a Command-line interface (CLI) tool that allows you to run Showdown converter from the command line.
|
|
|
|
Check the [CLI][cli] section in the documentation for more information.
|
|
|
|
## Contribution guide
|
|
|
|
If you want to contribute to the project, that's awesome! Please check our [guide][contribution-guide].
|
|
|
|
## Credits
|
|
|
|
Full credit list across the versions is available [here][credits].
|
|
|
|
## 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
|
|
[quickstart]: https://showdownjs.com/docs/quickstart/
|
|
[installation-methods]: https://showdownjs.com/docs/quickstart/#other-installation-methods
|
|
[extensions]: https://showdownjs.com/docs/extensions/
|
|
[cli]: https://showdownjs.com/docs/cli/
|
|
[contribution-guide]: https://showdownjs.com/docs/contribution-guide/
|
|
[credits]: https://showdownjs.com/docs/credits/ |