The minimal amount of CSS to replicate the GitHub Markdown style

Sindre Sorhus c6ccd73df4 2.0.2 10 years ago
.editorconfig 8f10b458e8 tweaks 10 years ago
.gitattributes 4c84b3ca10 init 11 years ago
.gitignore 4c84b3ca10 init 11 years ago
bower.json fe4922b3fe extract CSS generation into a separate module 10 years ago
github-markdown.css efc0dc1a3b regenerate github css 10 years ago
index.html 85784cc7b2 regenerate github css 10 years ago
license 4c84b3ca10 init 11 years ago
package.json bfc9fa896f 2.0.2 10 years ago
readme.md 85784cc7b2 regenerate github css 10 years ago

readme.md

github-markdown-css

The minimal amount of CSS to replicate the GitHub Markdown style

Demo

Install

Download manually or with a package-manager.

$ npm install --save github-markdown-css
$ bower install --save 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 790px width and 30px padding.

<link rel="stylesheet" href="github-markdown.css">
<style>
	.markdown-body {
		min-width: 200px;
		max-width: 790px;
		margin: 0 auto;
		padding: 30px;
	}
</style>
<article class="markdown-body">
	<h1>Unicorns</h1>
	<p>All the things</p>
</article>

How

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

Dev

Run npm run generate to update the CSS.

License

MIT © Sindre Sorhus