primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-03 15:35:29 +03:00
Code Issues Projects Releases Wiki Activity
8d7000cb4d
css/modules/primer-branch-name
History
Shawn Allen 101a8a2d5c Publish 
- primer-alerts@1.5.13
 - primer-avatars@1.5.10
 - primer-base@1.9.2
 - primer-blankslate@1.5.2
 - primer-box@2.5.13
 - primer-branch-name@1.0.11
 - primer-breadcrumb@1.5.9
 - primer-buttons@2.6.4
 - primer-core@6.10.8
 - primer-forms@2.1.8
 - primer-labels@1.5.13
 - primer-layout@1.6.2
 - primer-markdown@3.7.13
 - primer-marketing-buttons@1.0.13
 - primer-marketing-support@1.5.6
 - primer-marketing-type@1.4.13
 - primer-marketing-utilities@1.7.3
 - primer-marketing@6.3.3
 - primer-navigation@1.5.11
 - primer-page-headers@1.5.3
 - primer-page-sections@1.5.3
 - primer-pagination@1.0.7
 - primer-popover@0.1.8
 - primer-product@5.8.3
 - primer-progress@0.1.3
 - primer-subhead@1.0.11
 - primer-support@4.7.2
 - primer-table-object@1.4.13
 - primer-tables@1.5.3
 - primer-tooltips@1.5.11
 - primer-truncate@1.4.13
 - primer-utilities@4.14.3
 - primer@10.10.4
 - primer-module-build@1.0.10
2019-01-11 14:33:26 -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 update year in licenses and source headers to 2019 2019-01-04 10:38:46 -08:00
package.json Publish 2019-01-11 14:33:26 -08:00
README.md mark all examples with ERB as "erb", not "html" 2019-01-11 14:29:22 -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

npm version Build Status

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>

License

MIT © GitHub