@comsoc/gatsby-transformer-mdast v0.1.0

gatsby-transformer-remark

Parses Markdown files using Remark.

Install

npm install --save gatsby-transformer-remark

How to use

// In your gatsby-config.js
plugins: [
  `gatsby-transformer-remark`,
]

Parsing algorithm

It recongnizes files with the following extensions as Markdown.

• md
• rmd
• mkd
• mkdn
• mdwn
• mdown
• litcoffee
• markdown

Each Markdown file is parsed into a node of type MarkdownRemark.

All frontmatter fields are converted into GraphQL fields. TODO link to docs on auto-inferring types/fields.

This plugin adds additional fields to the MarkdownRemark GraphQL type including html, excerpt, headers, etc. Other Gatsby plugins can also add additional fields.

How to query

A sample GraphQL query to get MarkdownRemark nodes:

{
  allMarkdownRemark {
    edges {
      node {
        html
        frontmatter {
          # Assumes you're using title in your frontmatter.
          title
        }
      }
    }
  }
}