inst/www/github-markdown-css/readme.md

In robertzk/rocco: rocco (http://github.com/robertzk/rocco)

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

robertzk/rocco documentation built on May 27, 2019, 10:36 a.m.