primer/css

mirror of https://github.com/primer/css.git synced 2024-12-11 11:16:04 +03:00

History

Shawn Allen d5e8a55f0b add path metadata to all docs		2018-12-17 15:26:50 -08:00
..
lib	add branch-name SCSS and readme	2017-09-11 15:48:36 -07:00
index.scss	initial import of branch-name component	2017-09-11 14:28:47 -07:00
LICENSE	Happy new year	2018-01-03 15:05:16 -08:00
package.json	Publish	2018-11-19 10:43:02 -08:00
README.md	add path metadata to all docs	2018-12-17 15:26:50 -08:00
stories.js	Pulling in markdown components from all the rest of the modules	2018-01-09 15:27:14 -08:00

README.md

Primer / Branch Name

A nice, consistent way to display branch names.

This repository is a module of the full primer repository.

Install

This repository is distributed with npm. After installing npm, you can install primer-branch-name with this command.

$ npm install --save primer-branch-name

Usage

The source files included are written in Sass (SCSS) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "primer-branch-name/index.scss";

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled CSS version of this module, an npm script is included that will output a css version to build/build.css The built css file is also included in the npm package:

$ npm run build

Documentation

Branch names can be a link name or not:

<span class="branch-name">a_new_feature_branch</span>

<a href="#url" class="branch-name">a_new_feature_branch</a>

You may also include an octicon before the branch name text:

<span class="branch-name">
  <%= octicon("git-branch", width:16, height:16) %>
  a_new_feature_branch
</span>