https://github.com/teaglebuilt/gatsby-plugin-github-readme
React github readme card component for gatsby remark and mdx.
https://github.com/teaglebuilt/gatsby-plugin-github-readme
gatsby gatsby-plugin mdx react-component readme readme-md remark
Last synced: 5 months ago
JSON representation
React github readme card component for gatsby remark and mdx.
- Host: GitHub
- URL: https://github.com/teaglebuilt/gatsby-plugin-github-readme
- Owner: teaglebuilt
- Created: 2020-05-28T14:19:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T07:47:54.000Z (over 3 years ago)
- Last Synced: 2025-03-19T00:22:37.600Z (over 1 year ago)
- Topics: gatsby, gatsby-plugin, mdx, react-component, readme, readme-md, remark
- Language: JavaScript
- Size: 1.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
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
```js
plugins: [
{
resolve: `gatsby-plugin-github-readme`,
options: {
key: 'GITHUB API KEY',
repos: [
"user/repo",
"user/repo"
]
}
}
]
```
```js
import { GithubReadme } from "gatsby-plugin-github-readme";
export default () => {
}
```
# 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.