From c4eef0b8c13184e63941c1ae5db60defcb040b1d Mon Sep 17 00:00:00 2001 From: Antonio Date: Sat, 9 Apr 2022 13:39:50 +0300 Subject: [PATCH] docs: added section about cli extra options --- docs/cli.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index ddda916..d14754f 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -150,4 +150,22 @@ showdown makehtml [options] ```sh showdown makehtml -e ~/twitter.js -e ~/youtube.js - ``` \ No newline at end of file + ``` + +## 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).