gray-matter-loader/readme.md

A gray-matter loader module for webpack

# gray-matter-loader

> Webpack loader for extracting front-matter using [gray-matter](https://www.npmjs.com/package/gray-matter)

## Benefits

1. **Faster render**: The webpack loader runs at build time to pre-compile your front matter into json files for faster loading, removing the step to convert them at run-time.

2. **Smaller bundle**: There is no need to bundle gray-matter in you application anymore. Thus, saving you ~44kb of bundle size, see [bundlephobia: gray-matter](https://bundlephobia.com/result?p=gray-matter@latest)

## Usage:

Add gray-matter-loader to your project:

```sh
yarn add --dev gray-matter-loader
```

Add a rule in the webpack config of the project to use gray-matter-loader for files from which we need to extract the front-matter

```js
module: {
  rules: [
    {
      test: /\.md$/,
      use: [{ loader: "gray-matter-loader" }],
    },
  ];
}
```

After this, when you import file in you application you will get the parsed file in the following format:

```js
  "content": "Sample page content\n---\n\nRest on content from page\n",
  "data": {
    "title": "Sample",
    "description": "this is sample description"
  },
  "isEmpty": false,
}
```

The **_data_** property of the object has the front-matter and the content of the file is the _content_ property.

For further read please read docs for [gray-matter](https://www.npmjs.com/package/gray-matter)

## Using example

We have added an example project in this repo for testing. To run follow the following steps:

```sh
git clone https://github.com/ajaymathur/gray-matter-loader.git
cd gray-matter-loader
yarn
cd example
yarn webpack --watch
```

Now open the _index.html_ file in the example folder in a browser to see the output. Go ahead and edit sample.md and/ or webapck.config.js to test different use cases.