@locoworks/remark-folder-import

remark-code-import

📝 Populate code blocks from files in a folder.

Starting from v1.0.0, the plugin is now ESM only. Node 12+ is needed to use it and it must be imported instead of required.

Installation

npm install -D remark-folder-import

Setup

The plugin can be imported via named export, there's no default export.

import codeImport from 'remark-folder-import';

See Using plugins for more instructions in the official documentation.

It can also be used in various of libraries: remark: MDX, Gatsby gatsby-plugin-mdx, Storybook docs.

Usage

Transform:

```js path=./Hello name=Hello

```

into:

```js path=./Hello name=Hello
console.log('Hello remark-code-import!');
```

The file path is relative to the markdown file path. You can use <rootDir> at the start of the path to import files relatively from the rootDir:

```js path=<rootDir>/<path-to-file> name=<comman-file-name-to-import>

```

License

Shrey Dhyani MIT