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: added section about cli extra options

Browse Source
This commit is contained in:
Antonio 2022-04-09 13:39:50 +03:00
parent f3d73f5b54
commit c4eef0b8c1
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/cli.md
View File

@ -150,4 +150,22 @@ showdown makehtml [options]
```sh
showdown makehtml -e ~/twitter.js -e ~/youtube.js
```
```
## Extra options
You can specify any of the [supported options](available-options.md), and they will be passed to the converter.
For example, you can enable strikethrough support via the following command:
```
showdown makehtml -i foo.md -o bar.html --strikethrough
```
this command is equivalent of doing:
```js
var conv = new showdown.Converter({strikethrough: true});
```
!!! warning ""
In the CLI tool, all the extra options are **disabled** by default. This is the opposite of what is defined for node and browser, where some options, like `ghCodeBlocks` are enabled (for backward compatibility and historical reasons).