1.2.2 • Published 6 months ago
react-github-readme-md v1.2.2
react-github-readme-md
Render the README.md file of a GitHub Repository in React
Try switching your system between light and dark mode or add a .dark
class to a parent element to see the dark theme.
Features
- Supports both
light
anddark
modes - Works in both the client and server
Install
Using NPM:
$ npm install react-github-readme-md
Usage
import { GitHubReadme } from "react-github-readme-md";
// ...
<GitHubReadme username="lacymorrow" repo="react-github-readme-md" />
API
props.username
The GitHub username.
Required
Type: string
props.repo
The specified GitHub repository where the README.md
is located.
Required
Type: string
Credit
Thanks to Sindresorhus for his generate-github-markdown-css
repo, used to generate the styles!
License
1.2.0
7 months ago
1.1.1
7 months ago
1.1.0
7 months ago
1.0.9
7 months ago
1.0.8
7 months ago
1.0.7
7 months ago
1.1.5
7 months ago
1.0.6
7 months ago
1.1.4
7 months ago
1.0.5
7 months ago
1.2.2
6 months ago
1.1.3
7 months ago
1.0.4
7 months ago
1.2.1
6 months ago
1.1.2
7 months ago
1.0.3
8 months ago
1.0.2
8 months ago
1.0.1
8 months ago
1.0.0
8 months ago