Skip to content

Markdown CSS file that tries to look like Github markdown style

License

Notifications You must be signed in to change notification settings

bySabi/markdown-css--like-github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-css--like-github

CSS file that replicates the markdown styles of Github. Useful for use with modules that convert MD and MDX files to React components. Like @next/mdx or react-markdown

Installation

# NPM
npm i markdown-css--like-github

# Yarn
yarn add markdown-css--like-github

Usage

1- import CSS

from JS
import "markdown-css--like-github/index.css"
from CSS
@import "markdown-css--like-github"

2- Create a div container for the md files with className markdown-body

const Markdown = () => (
  <div className="markdown-body">
     <ComponentFromMDFile />
  </div>
)

Credits

author

original work

Contributing

  • Documentation improvement
  • Feel free to send any PR

License

MIT

About

Markdown CSS file that tries to look like Github markdown style

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages