github-markdown-css

WebJar for github-markdown-css

License

License

MIT
Categories

Categories

Github Development Tools Version Controls
GroupId

GroupId

org.webjars.bowergithub.sindresorhus
ArtifactId

ArtifactId

github-markdown-css
Last Version

Last Version

4.0.0
Release Date

Release Date

Type

Type

jar
Description

Description

github-markdown-css
WebJar for github-markdown-css
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/sindresorhus/github-markdown-css

Download github-markdown-css

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.sindresorhus/github-markdown-css/ -->
<dependency>
    <groupId>org.webjars.bowergithub.sindresorhus</groupId>
    <artifactId>github-markdown-css</artifactId>
    <version>4.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bowergithub.sindresorhus/github-markdown-css/
implementation 'org.webjars.bowergithub.sindresorhus:github-markdown-css:4.0.0'
// https://jarcasting.com/artifacts/org.webjars.bowergithub.sindresorhus/github-markdown-css/
implementation ("org.webjars.bowergithub.sindresorhus:github-markdown-css:4.0.0")
'org.webjars.bowergithub.sindresorhus:github-markdown-css:jar:4.0.0'
<dependency org="org.webjars.bowergithub.sindresorhus" name="github-markdown-css" rev="4.0.0">
  <artifact name="github-markdown-css" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bowergithub.sindresorhus', module='github-markdown-css', version='4.0.0')
)
libraryDependencies += "org.webjars.bowergithub.sindresorhus" % "github-markdown-css" % "4.0.0"
[org.webjars.bowergithub.sindresorhus/github-markdown-css "4.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

github-markdown-css

The minimal amount of CSS to replicate the GitHub Markdown style

Demo

Install

Download manually, from CDNJS, or with npm:

$ npm install 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, and 15px padding for mobile.

<meta name="viewport" content="width=device-width, initial-scale=1">
<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;
	}

	@media (max-width: 767px) {
		.markdown-body {
			padding: 15px;
		}
	}
</style>
<article class="markdown-body">
	<h1>Unicorns</h1>
	<p>All the things</p>
</article>

If you want code syntax highlighted, use GitHub Flavored Markdown rendered from GitHub's /markdown API.

How

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

Dev

Run npm run make to update the CSS.

Versions

Version
4.0.0