Skip to content

Commit

Permalink
docs: added section about cli extra options
Browse files Browse the repository at this point in the history
  • Loading branch information
bandantonio committed Apr 9, 2022
1 parent f3d73f5 commit c4eef0b
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit c4eef0b

Please sign in to comment.