react-github-readme-md v1.3.1

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 and dark 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

MIT © Lacy Morrow