docs: add cli extension docs (#2632)

This commit is contained in:
Tony Brix 2022-10-31 18:07:17 -05:00 committed by GitHub
parent b5bdcf9e03
commit 715f88aa9a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 0 deletions

View File

@ -184,3 +184,23 @@ markedWorker.onmessage = (e) => {
markedWorker.postMessage(markdownString);
```
<h2 id="cli-extensions">CLI Extensions</h2>
You can use extensions in the CLI by creating a new CLI that imports marked and the marked binary.
```js
// file: myMarked
#!/usr/bin/node
import { marked } from 'marked';
import customHeadingId from 'marked-custom-heading-id';
marked.use(customHeadingId());
import 'marked/bin/marked';
```
```sh
$ ./myMarked -s "# heading {#custom-id}"
<h1 id="custom-id">heading</h1>
```

View File

@ -43,6 +43,7 @@
<li><a href="/using_advanced#inline">Inline Markdown</a></li>
<li><a href="/using_advanced#highlight">Highlighting</a></li>
<li><a href="/using_advanced#workers">Workers</a></li>
<li><a href="/using_advanced#cli-extensions">CLI Extensions</a></li>
</ul>
</li>
<li>