The minimal amount of CSS to replicate the GitHub Markdown style

Sindre Sorhus 3324874049 2.0.5 10 年之前
.editorconfig 8f10b458e8 tweaks 10 年之前
.gitattributes 4c84b3ca10 init 11 年之前
.gitignore 4c84b3ca10 init 11 年之前
bower.json fe4922b3fe extract CSS generation into a separate module 10 年之前
github-markdown.css 667cc2dd9d regenerate github css 10 年之前
index.html 85784cc7b2 regenerate github css 10 年之前
license 4c84b3ca10 init 11 年之前
package.json e907e1c796 2.0.5 10 年之前
readme.md 85784cc7b2 regenerate github css 10 年之前

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