Package Exports

@johnrom/remark-code-import

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@johnrom/remark-code-import) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`remark-code-import`

📝 Populate code blocks from files

The plain remark version of gatsby-remark-import-code.

Installation

# npm
npm install -D remark-code-import

# yarn
yarn add -D remark-code-import

Setup

See Using plugins in the official documentation.

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

Use as Gatsby remark plugin

Just use the /gatsby endpoint. It's possible through to-gatsby-remark-plugin.

{
  resolve: 'remark-code-import/gatsby',
  options: {}
}

Usage

Transform:

```js file=./say-hi.js
```

into:

```js file=./say-hi.js
console.log('Hello remark-code-import!');
```

The file path is relative to the markdown file path.

You may also specify specific lines or ranges:

```js file=./say-hi.js#L3
```

```js file=./say-hi.js#L3-L6
```

```js file=./say-hi.js#L3-
```

Options

async: By default, this plugin uses readFileSync to read the contents of the files. Set this to true if you want to use readFile for non-blocking IO.

Testing

After installing dependencies with npm install, the tests can be run with: npm test

License

Kai Hao MIT