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

docs: add mention to makeMd() to reamde.md

Browse Source
This commit is contained in:
Estevao Soares dos Santos 2018-11-10 02:51:19 +00:00
parent e4b0e69724
commit a894a0e1db
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -106,6 +106,7 @@ Check our [wiki pages][wiki] for examples and a more in-depth documentation.
### Node
**Markdown to HTML**
```js
var showdown = require('showdown'),
converter = new showdown.Converter(),
@ -113,12 +114,21 @@ var showdown = require('showdown'),
html = converter.makeHtml(text);
```
**HTML to Markdown**
```js
var showdown = require('showdown'),
converter = new showdown.Converter(),
html = '<a href="https://patreon.com/showdownjs">Please Support us!</a>',
md = converter.makeMarkdown(text);
```
### Browser
```js
var converter = new showdown.Converter(),
text = '# hello, markdown!',
html = converter.makeHtml(text);
html = converter.makeHtml('# hello, markdown!'),
md = converter.makeMd('<a href="https://patreon.com/showdownjs">Please Support us!</a>');
```
### Output
@ -129,6 +139,10 @@ Both examples should output...
<h1 id="hellomarkdown">hello, markdown!</h1>
```
```md
[Please Support us!](https://patreon.com/showdownjs)
```
## Options
You can change some of showdown's default behavior through options.