@handbook/markdown-source-import


What does this do?

This tool gives two markdown comments.

For example,

``md


Source

List



`

This tool will transform the markdown document into the below.

``md


Source

`ts
// file.ts
console.log('hello world');
`

List

- packages/package1/README.md
- packages/package2/README.md
- packages/package3/README.md


``

Usage

Install

`sh
npm install @handbook/markdown-source-import --save-dev
`

Add a script to package.json

`json
{
"scripts": {
"source-import": "markdown-source-import README.md src/*/.md"
}
}
`

And if you use husky or the other pre-commit hook.

`json
{
"husky": {
"pre-commit": "markdown-source-import README.md src/*/.md --git-add"
}
}
`

Magic Comments

`md


Import Source

Single file

Multiple files

Glob

--pick (only support js, jsx, ts, tsx)

Create Index



`

See more

- @handbook/ This package is one of @handbook/` packages. Go to the project home and see more details.

Related Projects

-
-
-
-