Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

gatsby plugin github readme

Gatsby Plugin Homepage

Load github readme card components in jsx, remark, mdx.

npm package for gatsby-plugin-github-readme

Image of react card component of a github readme generated by gatsby-plugin-github-readme
npm i gatsby-plugin-github-readme

configuration

gatsby-config.js

plugins: [
    {
      resolve: `gatsby-plugin-github-readme`,
      options: {
        key: 'GITHUB API KEY',
        repos: [
          "user/repo",
          "user/repo"
        ]
      }
    }
]

Support

Emojis are supported and rendered if in scope of what is visible. Currently g-emoji is not supported and I am working on a solution.

© 2023 Gatsby, Inc.