5.2.0 • Published 2 months ago

gatsby-transformer-remark v5.2.0

Weekly downloads
137,838
License
MIT
Repository
github
Last release
2 months ago

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`];

A full explanation of how to use markdown in Gatsby can be found here: Creating a Blog with Gatsby

There are many Gatsby Remark plugins which you can install to customize how Markdown is processed. Many of them are demoed at https://using-remark.gatsbyjs.org/. See also the source code for using-remark.

Parsing algorithm

It recognizes 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, headings, etc. Other Gatsby plugins can also add additional fields.

How to query

A sample GraphQL query to get MarkdownRemark nodes:

{
  allMarkdownRemark {
    edges {
      node {
        html
        headings {
          depth
          value
        }
        frontmatter {
          # Assumes you're using title in your frontmatter.
          title
        }
      }
    }
  }
}
gatsby-developer-theme@pil0t/gatsby-theme-novela@thirdwave-network/thirdwave-gatsby-theme@lucasbarcelos/gatsby-theme-mercadolibre-store-custom@cangir/gatsby-blog-corerecipe-doc-site@sachinjadhav/gatsby-theme-bloggatsby-theme-sky-lite-master@studiobear/gatsby-theme-ionic@studiobear/gatsby-theme-blog@kyrelldixon/gatsby-theme-novela@one-builder/gatsby-theme-ob-mastergatsby-theme-ob-masterportfolio-gatsby@cangir/gatsby-theme-photo-core@cangir/gatsby-theme-portfolio-coregatsby-universal@nowseemee/monument@i1r0/gatsby-theme-nehalemgatsby-plugin-translate-urls-examplewebiu-testluandevtheme1gatsby-theme-lumencustom-gatsby-theme-novela@dsoaress/themegatsby-theme-jdoedocbot@leptest/gatsby-netlify-cmstest-theme-shawacademy@sandalboyz/gatsby-theme-sandalboyzgatsby-theme-sandalboyz@roman-hotsiy/redocly-dev-portal@redocly/portal@whey/gatsby-theme-whey@weknow/gatsby-theme-drupal-boina@wesleylhandy/gatsby-theme-author-base@westegg/gatsby-theme-serif@westegg/theme-jasper@westegg/city-limits@westegg/core@westegg/gatsby-theme-casper@westegg/gatsby-theme-core@zahradnik-io/gatsby-theme-novela@xops.net/gatsby-openrpc-themea-nice-bloggo-themegatsby-github-personal-websitegatsby-theme-albumgatsby-theme-docbargatsby-theme-sarvasyagatsby-theme-providence@matthieuauger/gatsby-theme-meetupjay-bloghubble-docs-themeklair.colisixianmikatre-themeocular-gatsbyreact-holidaypersonal-sitepiotr-s-brainhub-gatsby-docs-kitreact-dsxmbernetinaked_doclmnts-gatsby-ts-skeletonsavedalsloppetseeds-docsshamin-gatsby-themehemingway-clihemingway-doc-generatorraylogblog-themeboff-themeargo-sitebrawl-capped-webpagebart-van-der-waerdenfluent-rn-websiteflora-websiteformaregatsby-aamu-portfoliogatsby-aamu-startergatsby-all-pack-theme-startergatsby-theme-tyragatsby-theme-ultronelegatsby-theme-vloggatsby-theme-w3fgatsby-theme-whatsgood-fork-apollo-docsgatsby-theme-workshopsgatsby-theme-xdmorgangatsby-theme-yoshinogatsby-theme-yoyogatsby-theme-zhgatsby-plugin-xillio-docsgatsby-theme-early-birdgatsby-theme-edithgatsby-theme-editorialgatsby-theme-elementalgatsby-theme-elevator-pitchgatsby-theme-elkgatsby-theme-flora-websitegatsby-theme-forked-lam
5.1.4

2 months ago

5.1.3

2 months ago

5.1.2

2 months ago

5.1.1

2 months ago

5.2.0

2 months ago

5.2.0-next.2

2 months ago

5.2.0-next.1

2 months ago

5.3.0-next.1

2 months ago

5.3.0-next.0

2 months ago

5.1.0

3 months ago

5.2.0-next.0

3 months ago

5.1.0-next.0

3 months ago

5.0.0

3 months ago

5.0.0-zz-next.2

4 months ago

5.0.0-zz-next.3

3 months ago

4.11.0

4 months ago

5.0.0-zz-next.0

4 months ago

5.0.0-zz-next.1

4 months ago

5.0.0-next.2

4 months ago

5.0.0-next.1

4 months ago

5.0.0-next.0

4 months ago

4.11.0-next.4

4 months ago

4.11.0-next.2

4 months ago

4.11.0-next.1

5 months ago

4.10.0

5 months ago

4.11.0-next.0

5 months ago

4.10.0-next.2

5 months ago

4.10.0-next.1

5 months ago

4.9.0-coreutils.29

5 months ago

4.9.0

5 months ago

4.10.0-next.0

5 months ago

4.9.0-next.3

5 months ago

4.9.0-next.1

6 months ago

4.9.0-next.2

6 months ago

4.8.0

6 months ago

4.9.0-next.0

6 months ago

4.7.0

6 months ago

4.8.0-next.0

6 months ago

4.7.0-next.1

7 months ago

4.6.0

7 months ago

4.7.0-next.0

7 months ago

4.6.0-next.1

7 months ago

4.5.0

7 months ago

4.6.0-next.0

7 months ago

4.5.0-next.0

8 months ago

4.5.0-next.1

7 months ago

4.4.1

7 months ago

4.4.0

8 months ago

4.3.0

8 months ago

4.4.0-next.2

8 months ago

4.4.0-next.1

8 months ago

4.2.0-next.0

9 months ago

4.2.0-next.1

9 months ago

4.2.0

8 months ago

4.4.0-next.0

8 months ago

4.1.0

9 months ago

4.3.0-next.0

9 months ago

4.1.0-next.3

9 months ago

4.1.0-next.1

9 months ago

4.0.0

9 months ago

4.0.0-next.0

10 months ago

4.1.0-next.0

10 months ago

3.3.0-next.1

10 months ago

3.2.0

10 months ago

3.3.0-next.0

10 months ago

3.1.0

10 months ago

3.2.0-next.0

10 months ago

3.1.0-next.2

11 months ago

3.0.0

11 months ago

3.0.0-v3rc.0

11 months ago

3.1.0-next.1

11 months ago

3.1.0-next.0

11 months ago

3.0.0-next.3

11 months ago

2.16.1

11 months ago

3.0.0-next.2

11 months ago

3.0.0-next.1

11 months ago

3.0.0-next.0

12 months ago

2.16.0

12 months ago

2.17.0-next.0

12 months ago

2.15.0

12 months ago

2.16.0-next.0

1 year ago

2.15.0-next.1

1 year ago

2.14.0

1 year ago

2.15.0-next.0

1 year ago

2.14.0-next.2

1 year ago

2.13.1

1 year ago

2.14.0-next.1

1 year ago

2.13.0

1 year ago

2.14.0-next.0

1 year ago

2.13.0-next.1

1 year ago

2.12.0

1 year ago

2.13.0-next.0

1 year ago

2.11.1

1 year ago

2.11.0

1 year ago

2.12.0-next.0

1 year ago

2.10.0

1 year ago

2.10.0-next.1

1 year ago

2.11.0-next.0

1 year ago

2.10.0-next.0

1 year ago

2.9.2

1 year ago

2.9.1

1 year ago

2.9.0

1 year ago

2.8.47

1 year ago

2.8.46

1 year ago

2.8.45

1 year ago

2.8.44

1 year ago

2.8.43

1 year ago

2.8.41

1 year ago

2.8.42

1 year ago

2.8.40

1 year ago

2.8.39

1 year ago

2.8.38

1 year ago

2.8.37

1 year ago

2.8.36

1 year ago

2.8.35

1 year ago

2.8.34

1 year ago

2.8.33

1 year ago

2.8.32

1 year ago

2.8.31

1 year ago

2.8.30

1 year ago

2.8.29

1 year ago

2.8.28

1 year ago

2.8.27

1 year ago

2.8.26

1 year ago

2.8.25

2 years ago

2.8.24

2 years ago

2.8.23

2 years ago

2.8.22

2 years ago

2.8.20

2 years ago

2.8.19

2 years ago

2.8.18

2 years ago

2.8.17

2 years ago

2.8.16

2 years ago

2.8.15

2 years ago

2.8.14

2 years ago

2.8.13

2 years ago

2.8.12

2 years ago

2.8.11

2 years ago

2.8.10

2 years ago

2.8.9

2 years ago

2.8.8

2 years ago

2.8.7

2 years ago

2.8.6

2 years ago

2.8.5

2 years ago

2.8.4

2 years ago

2.8.3

2 years ago

2.8.0

2 years ago

2.7.5

2 years ago

2.7.4

2 years ago

2.7.3

2 years ago

2.7.2

2 years ago

2.7.1

2 years ago

2.7.0

2 years ago

2.6.59

2 years ago

2.6.58

2 years ago

2.6.57

2 years ago

2.6.56

2 years ago

2.6.55

2 years ago

2.6.54

2 years ago

2.6.53

2 years ago

2.6.52

2 years ago

2.6.51

2 years ago

2.6.50

2 years ago

2.6.49

2 years ago

2.6.48

2 years ago

2.6.47

2 years ago

2.6.45

2 years ago

2.6.44

2 years ago

2.6.43

2 years ago

2.6.42

2 years ago

2.6.41

2 years ago

2.6.39

2 years ago

2.6.38

2 years ago

2.6.37

2 years ago

2.6.36

2 years ago

2.6.35

2 years ago

2.6.34

2 years ago

2.6.33

2 years ago

2.6.32

2 years ago

2.6.31

2 years ago

2.6.30

2 years ago

2.6.29

2 years ago

2.6.28

2 years ago

2.6.27

2 years ago

2.6.26

2 years ago

2.6.24

2 years ago

2.6.23

2 years ago

2.6.22

2 years ago

2.6.21

2 years ago

2.6.20

2 years ago

2.6.19

2 years ago

2.6.18

2 years ago

2.6.17

2 years ago

2.6.16

2 years ago

2.6.15

2 years ago

2.6.14

2 years ago

2.6.13

2 years ago

2.6.12

2 years ago

2.6.11

2 years ago

2.6.10

2 years ago

2.6.9

2 years ago

2.6.8

3 years ago

2.6.7

3 years ago

2.6.6

3 years ago

2.6.5

3 years ago

2.6.4

3 years ago

2.6.3

3 years ago

2.6.2

3 years ago

2.6.1

3 years ago

2.6.0

3 years ago

2.5.0

3 years ago

2.4.0

3 years ago

2.3.12

3 years ago

2.3.11

3 years ago

2.3.10

3 years ago

2.3.9

3 years ago

2.3.8

3 years ago

2.3.7

3 years ago

2.3.6

3 years ago

2.3.5

3 years ago

2.3.4

3 years ago

2.3.3

3 years ago

2.3.2

3 years ago

2.3.1

3 years ago

2.3.1-alpha.0

3 years ago

2.3.0

3 years ago

2.2.6

3 years ago

2.2.5

3 years ago

2.2.4

3 years ago

2.2.3

3 years ago

2.2.2

3 years ago

2.2.1

3 years ago

2.2.0

3 years ago

2.1.20

3 years ago

2.1.19

3 years ago

2.1.18

3 years ago

2.1.17

3 years ago

2.1.16

3 years ago

2.1.15

3 years ago

2.1.14

3 years ago

2.1.13

3 years ago

2.1.12

3 years ago

2.1.11

3 years ago

2.1.10

3 years ago

2.1.9

3 years ago

2.1.8

3 years ago

2.1.7

3 years ago

2.1.6

3 years ago

2.1.5

3 years ago

2.1.4

3 years ago

2.1.3

3 years ago

2.1.2

3 years ago

2.1.1

3 years ago

2.1.1-rc.5

3 years ago

2.1.1-rc.1

3 years ago

2.1.1-rc.0

3 years ago

2.1.1-beta.8

3 years ago

2.1.1-beta.7

3 years ago

2.1.1-beta.6

3 years ago

2.1.1-beta.5

3 years ago

2.1.1-beta.4

4 years ago

2.1.1-beta.3

4 years ago

2.1.1-beta.2

4 years ago

2.1.1-beta.1

4 years ago

2.1.1-beta.0

4 years ago

1.7.44

4 years ago

2.1.1-alpha.2

4 years ago

2.0.1-17

4 years ago

1.7.43

4 years ago

2.0.1-16

4 years ago

2.0.1-15

4 years ago

2.0.1-14

4 years ago

1.7.42

4 years ago

2.0.1-13

4 years ago

2.0.1-12

4 years ago

2.0.1-11

4 years ago

2.0.1-10

4 years ago

1.7.41

4 years ago

2.0.1-7

4 years ago

2.0.1-6

4 years ago

2.0.1-5

4 years ago

2.0.1-4

4 years ago

2.0.1-3

4 years ago

1.7.40

4 years ago

1.7.39

4 years ago

1.7.38

4 years ago

2.0.1-2

4 years ago

1.7.37

4 years ago

1.7.36

4 years ago

1.7.35

4 years ago

2.0.1-1

4 years ago

1.7.34

4 years ago

1.7.33

4 years ago

2.0.1-0

4 years ago

1.7.32

4 years ago

1.7.31

4 years ago

1.7.30

4 years ago

1.7.29

4 years ago

1.7.28

4 years ago

1.7.27

4 years ago

1.7.26

4 years ago

1.7.25

4 years ago

1.7.24

4 years ago

1.7.23

4 years ago

1.7.22

4 years ago

1.7.21

4 years ago

1.7.20

4 years ago

1.7.19

4 years ago

1.7.18

4 years ago

1.7.17

4 years ago

1.7.16

4 years ago

1.7.15

4 years ago

1.7.14

4 years ago

1.7.12

4 years ago

1.7.11

4 years ago

1.7.10

4 years ago

1.7.9

4 years ago

1.7.8

4 years ago

1.7.7

4 years ago

1.7.6

4 years ago

1.7.5

4 years ago

1.7.4

4 years ago

1.7.3

4 years ago

1.7.2

4 years ago

1.7.1

4 years ago

1.7.0

4 years ago

1.6.3

4 years ago

1.1.0

5 years ago

1.0.9

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago

1.0.0-beta.6

5 years ago

1.0.0-beta.1

5 years ago

1.0.0-alpha.23

5 years ago

1.0.0-alpha.22

5 years ago

1.0.0-alpha20

5 years ago

1.0.0-alpha19

5 years ago

1.0.0-alpha17

5 years ago

1.0.0-alpha16

5 years ago

1.0.0-alpha15

5 years ago

1.0.0-alpha14

5 years ago

1.0.0-alpha13

5 years ago