teaglebuilt / gatsby-plugin-github-readme

React github readme card component for gatsby remark and mdx.

gatsby plugin github readme

Gatsby Plugin Homepage

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

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"
        ]
      }
    }
]

import { GithubReadme } from "gatsby-plugin-github-readme";

export default () => {
  <GithubReadme user="user" repo="name of 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.