| .github/workflows | ||
| bin | ||
| dist | ||
| docs | ||
| src | ||
| test | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| .jshintignore | ||
| .jshintrc | ||
| bower.json | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| DONATIONS.md | ||
| Gruntfile.js | ||
| karma.browserstack.js | ||
| karma.conf.js | ||
| LICENSE | ||
| mkdocs.yml | ||
| package-lock.json | ||
| package.json | ||
| performance.json | ||
| performance.log.md | ||
| README.md | ||
| SECURITY.md | ||
| TASKS.TODO.md | ||
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
Who uses Showdown (or a fork)
- Antmarky
- GoogleCloudPlatform
- Meteor
- StackExchange - forked as PageDown
- docular
- md-page
- QCObjects
- and some others
Quickstart
Check our documentation for the quickstart guide and possible 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 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 section in the documentation for more information.
Contribution guide
If you want to contribute to the project, that's awesome! Please check our guide.
Credits
Full credit list across the versions is available here.
License
ShowdownJS v 2.0 is release under the MIT version.
Previous versions are release under BSD.