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

Browse Source
This commit is contained in:
Titus 2012-06-20 17:34:12 -06:00
parent bfa99b3af5
commit c647e8e168
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -105,6 +105,33 @@ Showdown has been tested successfully with:
In theory, Showdown will work in any browser that supports ECMA 262 3rd Edition (JavaScript 1.5). The converter itself might even work in things that aren't web browsers, like Acrobat. No promises. In theory, Showdown will work in any browser that supports ECMA 262 3rd Edition (JavaScript 1.5). The converter itself might even work in things that aren't web browsers, like Acrobat. No promises.
Extensions
----------
Showdown allows additional functionality to be loaded via extensions.
### Client-side Extension Usage
```js
<script src="src/showdown.js" />
<script src="src/extensions/twitter.js" />
var converter = new Showdown().converter({
extensions: [
Showdown.extensions.twitter
]
})
```
### Server-side Extension Usage
```js
var Showdown = require('showdown');
var twitter = require('showdown.extensions.twitter');
var converter = new Showdown().converter({ extensions: [twitter] });
```
Known Differences in Output Known Differences in Output
--------------------------- ---------------------------