npm package: @forestryio/gatsby-remark-normalize-paths
Description: Normalize paths in frontmatter and body of markdown files to be gatsby compliant
Author: Cédric Delpoux
Latest version: 1.0.0

# gatsby-remark-normalize-paths

[![npm package][npm-badge]][npm]

`gatsby-remark-normalize-paths` normalize your paths to be gatsby compliant.

It find absolute paths deeply in the frontmatter and the body of your markdown files and transform them to relative paths. If you have empty fields, it delete them (optional).

## Usecase

-   You use a CMS (eg: [Netlify-cms](https://github.com/netlify/netlify-cms)) to manage your markdown files but it do not format paths like gatsby want to.
-   You use `gatsby-transformer-sharp` and your images fields should not be empty to avoid the error `GraphQL Error Field must not have a selection since type "String" has no subfields` when you build,

Let's imagine your gatsby data structure is the following:

```
/
  ↳ content
    ↳ posts
      ↳ post-1.md
    ↳ images
      ↳ image-1.jpeg
      ↳ image-2.jpeg
      ↳ image-3.jpeg
      ↳ image-4.jpeg
      ↳ image-5.jpeg
  ↳ src
  ↳ public
  ↳ static
```

And your markdown files containing absolute paths:

```markdown
---
title: "Post 1"
cover: "/content/images/image-1.jpg"
images:
    - "/content/images/image-2.jpg"
    - "/content/images/image-3.jpg"
    - "/content/images/image-4.jpg"
---

Lorem ipsum ![](/content/images/image-5.jpg) Lorem ipsum
```

In your markdown frontmatter or body, you can use absolute paths (`/content/images/image-1.jpg`) and it will be convert to relative paths (`../images/image-1.jpg`)

## Getting started

[![gatsby-remark-normalize-paths](https://nodei.co/npm/gatsby-remark-normalize-paths.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/gatsby-remark-normalize-paths/)

You can download `gatsby-remark-normalize-paths` from the NPM registry via the
`npm` or `yarn` commands

```shell
yarn add gatsby-remark-normalize-paths
npm install gatsby-remark-normalize-paths --save
```

## Usage

Add the plugin in your `gatsby-config.js` file:

```js
module.exports = {
    plugins: [
        {
            resolve: "gatsby-transformer-remark",
            options: {
                plugins: [
                    // without options
                    "gatsby-remark-normalize-paths"
                    // or
                    // with options
                    {
                        resolve: "gatsby-remark-normalize-paths",
                        options: {
                            pathFields: ["image", "cover"],
                        },
                    },
                ],
            },
        },
    ],
}
```

> Note:
> If you don't want this plugin delete empty frontmatter of some fields, you need to specify pathFields

## Contributing

-   ⇄ Pull/Merge requests and ★ Stars are always welcome.
-   For bugs and feature requests, please [create an issue][github-issue].

See [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines

## Changelog

See [CHANGELOG.md](./CHANGELOG.md)

## License

This project is licensed under the MIT License - see the
[LICENCE.md](./LICENCE.md) file for details

[npm-badge]: https://img.shields.io/npm/v/gatsby-remark-normalize-paths.svg?style=flat-square
[npm]: https://www.npmjs.org/package/gatsby-remark-normalize-paths
[github-issue]: https://github.com/xuopled/gatsby-remark-normalize-paths/issues/new