forked from showdownjs/showdown
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added extensions overview page
- Loading branch information
1 parent
bdddfb9
commit d11e5cf
Showing
2 changed files
with
39 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
Showdown allows you to load additional functionality via extensions. You can find a list of known Showdown extensions [here][ext-wiki]. | ||
|
||
You can also check the [boilerplate repo][boilerplate-repo], to create your own extension(s). | ||
|
||
## Usage | ||
|
||
=== "Server-side" | ||
|
||
```js | ||
// Using a bundled extension | ||
var showdown = require('showdown'); | ||
var converter = new showdown.Converter({ extensions: ['twitter'] }); | ||
|
||
// Using a custom extension | ||
var mine = require('./custom-extensions/mine'); | ||
var converter = new showdown.Converter({ extensions: ['twitter', mine] }); | ||
``` | ||
|
||
=== "Client-side" | ||
|
||
```js | ||
<script src="src/showdown.js"></script> | ||
<script src="src/extensions/twitter.js"></script> | ||
<script>var converter = new showdown.Converter({ extensions: ['twitter'] });</script> | ||
``` | ||
|
||
=== "CLI" | ||
|
||
In the CLI tool, use the [`-e` flag](/cli/#-e-extensions) to load an extension. | ||
|
||
```sh | ||
showdown -e twitter -i foo.md -o bar.html | ||
``` | ||
|
||
[ext-wiki]: https://github.com/showdownjs/showdown/wiki/extensions | ||
[boilerplate-repo]: https://github.com/showdownjs/extension-boilerplate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters