StarMirror/github-markdown-css
1
0
Fork 0
mirror of https://github.com/sindresorhus/github-markdown-css.git synced 2024-03-22 13:10:53 +08:00
Code Issues Projects Releases Wiki Activity
The minimal amount of CSS to replicate the GitHub Markdown style
74 Commits 1 Branch 46 Tags 651 KiB
CSS 53.1%
HTML 46.9%
bc33ebdd05
Go to file
Tyler Long bc33ebdd05 Close #22 PR: Fix octicons issue & More comprehensive demo page.
2016-01-09 16:38:08 +01:00
.editorconfig tweaks 2014-08-19 01:14:43 +02:00
.gitattributes init 2014-05-07 20:25:28 +02:00
.gitignore init 2014-05-07 20:25:28 +02:00
bower.json extract CSS generation into a separate module 2014-11-27 21:54:24 +07:00
github-markdown.css Close #22 PR: Fix octicons issue & More comprehensive demo page. 2016-01-09 16:38:08 +01:00
index.html Close #22 PR: Fix octicons issue & More comprehensive demo page. 2016-01-09 16:38:08 +01:00
license init 2014-05-07 20:25:28 +02:00
package.json update to new GitHub readme width 2015-12-06 19:56:04 +01:00
readme.md update to new GitHub readme width 2015-12-06 19:56:04 +01:00

readme.md

github-markdown-css

The minimal amount of CSS to replicate the GitHub Markdown style

Demo

Install

Download manually or with npm:

$ npm 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 980px width and 45px padding.

<link rel="stylesheet" href="github-markdown.css">
<style>
	.markdown-body {
		box-sizing: border-box;
		min-width: 200px;
		max-width: 980px;
		margin: 0 auto;
		padding: 45px;
	}
</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