Skip to content

Instantly share code, notes, and snippets.

@tuzz
Last active Sep 13, 2022
Embed
What would you like to do?
Github Markdown Stylesheet
/*
Copyright (c) 2017 Chris Patuzzo
https://twitter.com/chrispatuzzo
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
body {
font-family: Helvetica, arial, sans-serif;
font-size: 14px;
line-height: 1.6;
padding-top: 10px;
padding-bottom: 10px;
background-color: white;
padding: 30px;
color: #333;
}
body > *:first-child {
margin-top: 0 !important;
}
body > *:last-child {
margin-bottom: 0 !important;
}
a {
color: #4183C4;
text-decoration: none;
}
a.absent {
color: #cc0000;
}
a.anchor {
display: block;
padding-left: 30px;
margin-left: -30px;
cursor: pointer;
position: absolute;
top: 0;
left: 0;
bottom: 0;
}
h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
cursor: text;
position: relative;
}
h2:first-child, h1:first-child, h1:first-child + h2, h3:first-child, h4:first-child, h5:first-child, h6:first-child {
margin-top: 0;
padding-top: 0;
}
h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor {
text-decoration: none;
}
h1 tt, h1 code {
font-size: inherit;
}
h2 tt, h2 code {
font-size: inherit;
}
h3 tt, h3 code {
font-size: inherit;
}
h4 tt, h4 code {
font-size: inherit;
}
h5 tt, h5 code {
font-size: inherit;
}
h6 tt, h6 code {
font-size: inherit;
}
h1 {
font-size: 28px;
color: black;
}
h2 {
font-size: 24px;
border-bottom: 1px solid #cccccc;
color: black;
}
h3 {
font-size: 18px;
}
h4 {
font-size: 16px;
}
h5 {
font-size: 14px;
}
h6 {
color: #777777;
font-size: 14px;
}
p, blockquote, ul, ol, dl, li, table, pre {
margin: 15px 0;
}
hr {
border: 0 none;
color: #cccccc;
height: 4px;
padding: 0;
}
body > h2:first-child {
margin-top: 0;
padding-top: 0;
}
body > h1:first-child {
margin-top: 0;
padding-top: 0;
}
body > h1:first-child + h2 {
margin-top: 0;
padding-top: 0;
}
body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child {
margin-top: 0;
padding-top: 0;
}
a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}
h1 p, h2 p, h3 p, h4 p, h5 p, h6 p {
margin-top: 0;
}
li p.first {
display: inline-block;
}
ul, ol {
padding-left: 30px;
}
ul :first-child, ol :first-child {
margin-top: 0;
}
ul :last-child, ol :last-child {
margin-bottom: 0;
}
dl {
padding: 0;
}
dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}
dl dt:first-child {
padding: 0;
}
dl dt > :first-child {
margin-top: 0;
}
dl dt > :last-child {
margin-bottom: 0;
}
dl dd {
margin: 0 0 15px;
padding: 0 15px;
}
dl dd > :first-child {
margin-top: 0;
}
dl dd > :last-child {
margin-bottom: 0;
}
blockquote {
border-left: 4px solid #dddddd;
padding: 0 15px;
color: #777777;
}
blockquote > :first-child {
margin-top: 0;
}
blockquote > :last-child {
margin-bottom: 0;
}
table {
padding: 0;
}
table tr {
border-top: 1px solid #cccccc;
background-color: white;
margin: 0;
padding: 0;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
table tr th {
font-weight: bold;
border: 1px solid #cccccc;
text-align: left;
margin: 0;
padding: 6px 13px;
}
table tr td {
border: 1px solid #cccccc;
text-align: left;
margin: 0;
padding: 6px 13px;
}
table tr th :first-child, table tr td :first-child {
margin-top: 0;
}
table tr th :last-child, table tr td :last-child {
margin-bottom: 0;
}
img {
max-width: 100%;
}
span.frame {
display: block;
overflow: hidden;
}
span.frame > span {
border: 1px solid #dddddd;
display: block;
float: left;
overflow: hidden;
margin: 13px 0 0;
padding: 7px;
width: auto;
}
span.frame span img {
display: block;
float: left;
}
span.frame span span {
clear: both;
color: #333333;
display: block;
padding: 5px 0 0;
}
span.align-center {
display: block;
overflow: hidden;
clear: both;
}
span.align-center > span {
display: block;
overflow: hidden;
margin: 13px auto 0;
text-align: center;
}
span.align-center span img {
margin: 0 auto;
text-align: center;
}
span.align-right {
display: block;
overflow: hidden;
clear: both;
}
span.align-right > span {
display: block;
overflow: hidden;
margin: 13px 0 0;
text-align: right;
}
span.align-right span img {
margin: 0;
text-align: right;
}
span.float-left {
display: block;
margin-right: 13px;
overflow: hidden;
float: left;
}
span.float-left span {
margin: 13px 0 0;
}
span.float-right {
display: block;
margin-left: 13px;
overflow: hidden;
float: right;
}
span.float-right > span {
display: block;
overflow: hidden;
margin: 13px auto 0;
text-align: right;
}
code, tt {
margin: 0 2px;
padding: 0 5px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}
pre code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}
.highlight pre {
background-color: #f8f8f8;
border: 1px solid #cccccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre {
background-color: #f8f8f8;
border: 1px solid #cccccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}
pre code, pre tt {
background-color: transparent;
border: none;
}
@johnagan
Copy link

johnagan commented Jun 28, 2013

Love this stylesheet! Thanks for doing this.

Noticed this url isn't working though.

Copy link

ghost commented Jul 29, 2013

Awesome stylesheet! Using this in my Chrome extension.

@coopy
Copy link

coopy commented Aug 15, 2013

@tuzz This looks good. Are you the original author, and is there a particular license on the stylesheet?

@gaving
Copy link

gaving commented Jan 30, 2014

Awesome stylesheet.

@greyblake
Copy link

greyblake commented Mar 2, 2014

Big thanks! I hope you won't mind me using your stylesheet in vim-preview plugin: https://github.com/greyblake/vim-preview

@msarchet
Copy link

msarchet commented May 14, 2014

Do you have a license?

@sindresorhus
Copy link

sindresorhus commented Nov 18, 2014

For an up-to-date stylesheet, see https://github.com/sindresorhus/github-markdown-css

@cdwichlaz
Copy link

cdwichlaz commented Feb 22, 2016

How do you make a css stylesheet for html on github and github windows using Sublime Text

@hydrothrone
Copy link

hydrothrone commented Sep 5, 2017

do you some other darkness style scheme?

@jiangkunhe
Copy link

jiangkunhe commented Sep 18, 2017

table {border-collapse:collapse;} look beterr

@tuzz
Copy link
Author

tuzz commented Nov 17, 2017

Hi everyone, sorry I didn't realise this had become (somewhat) popular.

This stylesheet is based on GitHub's styles circa mid-2012.

It's not a copy, but was heavily inspired by theirs and closely replicates their visual design.

You're welcome to use it under the MIT license which I have included in the gist.

I don't plan to maintain this. There are plenty of great forks you should check out.

@nickolaskraus-wf
Copy link

nickolaskraus-wf commented Mar 9, 2018

@jiangkunhe Thank you

In order to remove the small, interstitial spaces between cells, add the following to your css:

table {
  padding: 0;
  border-collapse:collapse;
}

Before:
screen shot 2018-03-09 at 14 34 56

After:
screen shot 2018-03-09 at 14 35 12

@davincif
Copy link

davincif commented Oct 22, 2018

Can anyone explain me how this style works on github. Or even if it works at all. I'm finding answers that says that css styling like this can not be done on github, see this.
Personally, I've tried it several times already, never being able to do such a thing, but I'd love to.

@travishen
Copy link

travishen commented Oct 23, 2018

Awesome!

@S0C7
Copy link

S0C7 commented Feb 17, 2019

@tuzz: Is there any possible way to implement these stylesheets into README.md markdown so it shows on GitHub? Just including the .css in <link href> in the markdown doesn't seem to work on GitHub.

@scott-joe
Copy link

scott-joe commented Apr 11, 2019

@davincif what are you trying to do? The purpose of this is to emulate the CSS used within the markdown viewer and wiki pages. It's meant to be used elsewhere.

@tuzz that's not how it works. If you want to change how you see github readmes, you can add an adjusted version of this to a browser plugin like Stylebot. If you're trying to change how everyone sees your readme, you're out of luck. You may be able to edit inline styling, but that's probably it. Read the Markdown documentation and Github's Markdown documentation for more on what's allowed within markdown.

@leobrines
Copy link

leobrines commented Jul 4, 2019

This is the original css that uses Github https://primer.style/css/getting-started
😄

@nodingneu
Copy link

nodingneu commented Aug 8, 2019

This scrolls pres horizontally bad for me, the code overlaps and sticks out the edge of the pre and the pre moves inside of the div, not the code inside of the pre

@JFLarvoire
Copy link

JFLarvoire commented Dec 6, 2019

@tuzz Thanks for publishing this:
I've reused your style sheet in a Windows batch script that converts a Markdown file to HTML, and displays it in a Web browser.
The batch is described here: https://www.dostips.com/forum/viewtopic.php?f=3&t=9372
And it is available there: https://github.com/JFLarvoire/SysToolsLib/blob/master/Batch/md2h.bat

@nathan-chappell
Copy link

nathan-chappell commented Jun 18, 2020

For just wanting something that looks good enough to not have someone bother you about it, this plus Markdown is perfect.

@ildar-shaimordanov
Copy link

ildar-shaimordanov commented Jul 30, 2020

I am glad to announce that this style sheet is used in my tiny humble project at https://github.com/ildar-shaimordanov/git-markdown-html.

@Yash-Singh1
Copy link

Yash-Singh1 commented Aug 2, 2020

Thanks!

I wish I was as skilled in CSS 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment