showdown/README.md

![Showdown][sd-logo]

![Build Status: Linux](https://github.com/showdownjs/showdown/actions/workflows/node.linux.yml/badge.svg)
![Build Status: Windows](https://github.com/showdownjs/showdown/actions/workflows/node.win.yml/badge.svg)
[![npm version](https://badge.fury.io/js/showdown.svg)](http://badge.fury.io/js/showdown)
[![Bower version](https://badge.fury.io/bo/showdown.svg)](http://badge.fury.io/bo/showdown)
[![Join the chat at https://gitter.im/showdownjs/showdown](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/showdownjs/showdown?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](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/
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00			`![Showdown][sd-logo]`
Major code refactoring 2015-01-16 05:21:33 +08:00
Chore/update ci (#876) * chore(ci): update CI node version to match node supported versions * chore(ci): appveyor only supports up to node 16.x * chore(ci): travis CI is not longer free/working; remove it * chore(ci): add git workflow to replace travisCI linux builds * doc(readme): add back in a badge for linux CI * chore(ci): add windows to CI * chore(ci): remove appveyor in favor of github actions * doc(readme): update info about node supportability 2021-11-15 03:58:28 +08:00			`![Build Status: Linux](https://github.com/showdownjs/showdown/actions/workflows/node.linux.yml/badge.svg)`
			`![Build Status: Windows](https://github.com/showdownjs/showdown/actions/workflows/node.win.yml/badge.svg)`
chore: update README.md to include appveyor badge 2017-03-05 13:21:42 +08:00			`[![npm version](https://badge.fury.io/js/showdown.svg)](http://badge.fury.io/js/showdown)`
			`[![Bower version](https://badge.fury.io/bo/showdown.svg)](http://badge.fury.io/bo/showdown)`
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`[![Join the chat at https://gitter.im/showdownjs/showdown](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/showdownjs/showdown?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
Update README.md 2017-11-21 00:36:05 +08:00			`[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/tiviesantos)`
docs(README.md): add note for legacy branch 2015-05-27 23:31:04 +08:00
Update README.md 2022-03-20 23:26:13 +08:00			`Showdown is a JavaScript Markdown to HTML converter, based on the original works by John Gruber.`
docs(README.md): add live demo 2015-07-14 10:34:37 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Showdown can be used on the client-side (in the browser) or server-side (with Node.js).`
docs(README.md): add live demo 2015-07-14 10:34:37 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`----`
Update README.md 2018-11-04 11:03:11 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`## Live demo`
Update README.md 2018-11-04 11:03:11 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`<http://demo.showdownjs.com/>`
Major code refactoring 2015-01-16 05:21:33 +08:00
docs(README.md): add libraries that use showdown 2015-08-23 10:31:55 +08:00			`## Who uses Showdown (or a fork)`

docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`* [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)`
docs(README.md): add options section 2015-05-27 09:20:29 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`## Quickstart`
docs(README.md): add options section 2015-05-27 09:20:29 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Check our documentation for the [quickstart guide][quickstart]`
			`and possible [installation methods][installation-methods].`
feat(customizeHeaderId): add option for customizing header ids It’s useful for non-Latin texts, where header might be, for example, in Russian, but user wants id to be in English. This feature allows user to set id for header manually, using curly braces: ## Привет, мир {hello-world} Closes #383 2017-06-01 09:35:42 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`## Showdown features`
feat(ghCompatibleHeaderId): generate header ids compatible with github style Github replaces spaces with dashes and removes a bunch of characters from generated header ids ][&~$!@#*()=:/,;?+'.\ This feature implements this. Closes # 320, closes #321 2016-12-31 03:01:44 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`### Platform-agnostic`
chore(readme.md): format and add references to readme.md 2017-08-07 00:51:29 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Showdown can easily be used on server-side and client-side.`
feat(rawPrefixHeaderId): add option to prevent showdown from modifying the prefix Setting this option to true will prevent showdown from modifying the prefix. This might result in malformed IDs (if, for instance, the " char is used in the prefix). Has no effect if prefixHeaderId is set to false. Closes #409 2017-08-07 01:19:46 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`### Two-way conversion`
docs(README.md): add options section 2015-05-27 09:20:29 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Showdown not only helps you to convert your Markdown documents into HTML but also can bring them back to Markdown from HTML.`
Update README.md 2015-07-15 18:15:39 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`### Extensions`
chore: update readme and add TASKS.TODO.md 2018-09-16 10:45:07 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Expand Showdown's functionality using a powerful [extension system][extensions]. Extensions can also be used on server-side and client-side.`
Update README.md 2015-07-15 18:15:39 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`### CLI`
Update README.md 2015-07-15 18:15:39 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Showdown comes bundled with a Command-line interface (CLI) tool that allows you to run Showdown converter from the command line.`
feat(literalMidWordAsterisks): add option for mid word asterisks Implements feature similar to ignoring midword underscores but with asterisks. The main use case is ignoring cursing. 2017-04-05 23:25:20 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Check the [CLI][cli] section in the documentation for more information.`
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`## Contribution guide`
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`If you want to contribute to the project, that's awesome! Please check our [guide][contribution-guide].`
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`## Credits`
docs(README.md): update documentation and credits 2015-05-16 07:09:24 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Full credit list across the versions is available [here][credits].`
Major code refactoring 2015-01-16 05:21:33 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`## License`
docs(README.md): add "powered by webstorm" 2015-05-16 07:29:22 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`ShowdownJS v 2.0 is release under the MIT version.`
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`Previous versions are release under BSD.`
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`----`
docs(README.md): update docs to match new version 2015-07-14 04:35:18 +08:00
			`[sd-logo]: https://raw.githubusercontent.com/showdownjs/logo/master/dist/logo.readme.png`
docs: update README to get rid of overlapping info from main docs 2022-05-14 06:02:26 +08:00			`[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/`