github-markdown-css

> The minimal amount of CSS to replicate the GitHub Markdown style

The CSS is generated. Contributions should go to this repo.

Demo

Install

Download manually, from CDNJS, or with npm:

``sh
npm install github-markdown-css
`

Usage

Import the github-markdown.css file and add a markdown-body class to the container of your rendered Markdown and set a width for it. GitHub uses 980px width and 45px padding, and 15px padding for mobile.

`html





Unicorns

All the things


`

You can use GitHub's /markdown API to turn Markdown into the HTML that GitHub generates, which works well with the CSS in this repo. Other Markdown parsers will mostly work with these styles too. To mimic how GitHub highlights code, you can use starry-night with your Markdown parser of choice.

There are 7 themes provided in this package:

- github-markdown.css: (default) Automatically switches between light and dark through @media (prefers-color-scheme).
- github-markdown-light.css: Light-only.
- github-markdown-dark.css: Dark-only.
- github-markdown-dark-dimmed.css: Dark dimmed.
- github-markdown-dark-high-contrast.css: Dark high contrast.
- github-markdown-dark-colorblind.css: Dark Protanopia & Deuteranopia.
- github-markdown-light-colorblind.css: Light Protanopia & Deuteranopia.

How

See generate-github-markdown-css for how it's generated and ability to generate your own.

Troubleshooting

If you encounter styling issues, like tables in dark mode rendering their fonts in black, the browser might uses quirks mode by accident.

To avoid quirks mode, always include a doctype at the top of your page.

`html


`

Dev

Run npm run make` to update the CSS.