StarMirror/showdown
1
0
Fork 0
mirror of https://github.com/showdownjs/showdown.git synced 2024-03-22 13:30:55 +08:00
Code Issues Projects Releases Wiki Activity

Updated README with new inclusion syntax

Browse Source
This commit is contained in:
Titus 2012-06-20 21:19:56 -06:00
parent 05453b5042
commit 22056db9a7
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -116,22 +116,23 @@ Showdown allows additional functionality to be loaded via extensions.
<script src="src/showdown.js" />
<script src="src/extensions/twitter.js" />
var converter = new Showdown().converter({
extensions: [
Showdown.extensions.twitter
]
})
var converter = new Showdown().converter({ extensions: 'twitter' });
```
### Server-side Extension Usage
```js
// Using a bundled extension
var Showdown = require('showdown');
var twitter = Showdown.extensions.twitter;
var converter = new Showdown().converter({ extensions: [twitter] });
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] });
```
Known Differences in Output
---------------------------