markdown-code-example-inserter

Syncs markdown documentation with code examples.

Install

Via npm:

``bash
npm i -D markdown-code-example-inserter
`

It's recommended to install this package as a dev dependency as it is a build-step operation.

Usage

Markdown files

Add an HTML comment that starts with the following text: example-link:. Then after that text, include a file path to the example file:

`html

`

Here's an example from the GitHub repo. And here is the same file with the code examples inserted.

CLI

`bash
npx md-code file1.md file2.md [...moreFiles]
`

Any of the file names can be a glob. Put the glob in quotes if you wish to prevent your shell from expanding it (this package will expand the glob):

`bash
npx md-code "./*.md"
`

$3

Use --check.

Check if the given files are updated, don't write anything.

`bash
npx md-code file1.md --check
`

$3

Use --index.

Force an index file for imports that should be rewritten with your package name:

`bash
npx md-code file1.md --index path/to/index.ts file2.md [...moreFiles]
`

The index file is used to replace relative imports with package name imports. Like changing import from '../../index' to import from 'my-package'.

$3

Use --ignore.

`bash
npx md-code ".//.md" --ignore "./test-files//"
`

Multiple --ignore patterns can be used:

`bash
npx md-code ".//.md" --ignore "./test-files//" -ignore "./test-files/*/"
`

node_modules is automatically ignored.

$3

Use --silent

`bash
npx md-code --silent file1.md
``