Skip to content

teaglebuilt/gatsby-plugin-github-readme

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

gatsby plugin github readme

Gatsby Plugin Homepage

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

npm package for gatsby-plugin-github-readme downloads for gatsby-plugin-github-readme from npm unit tests build

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

About

React github readme card component for gatsby remark and mdx.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published