Stylesheets for rendering GitHub Flavored Markdown and syntax highlighted code snippets (powered by Pygments). Built to be used with Primer.
Read the Primer documentation to learn more.
Heads up! We love open source, but Primer and its projects are unlikely to add new features that are not used in GitHub.com. It's first and foremost our CSS toolkit. We really love to share though, so hopefully that means we're still friends <3.
The GitHub user content stylesheets ship in two formats, CSS and SCSS.
user-content.css
— Compiled CSS file ready to drop into any environment. Contains both Markdown and syntax stylesheets.user-content.min.css
— Minified version ofuser-content.css
markdown.scss
— Source SCSS file for rendering markdownuser-content.scss
—@imports
both of the above. If you import this file, you do not need to import the others.
The stylesheets are written in SCSS and compiled to regular CSS. Also included is a Gruntfile for local project development.
- Install
grunt-cli
globally withnpm install -g grunt-cli
. - Navigate to the root
/markdown
directory, then runnpm install
to install the necessary dependencies. - Done! Now you can run
grunt
from the command line to compile SCSS to CSS.
Unfamiliar with npm
? Don't have node installed? That's a-okay. npm is a way to manage development dependencies through node.js. Download and install node.js before proceeding.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
All HTML and CSS should conform to the style guidelines.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.
For transparency into our release cycle and in striving to maintain backward compatibility, Primer is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.
Created by and copyright GitHub, Inc. Released under the MIT license.