2.0 KiB
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>