2064c1b00b
- primer-alerts@1.5.6 - primer-avatars@1.5.3 - primer-base@1.7.1 - primer-blankslate@1.4.6 - primer-box@2.5.6 - primer-branch-name@1.0.4 - primer-breadcrumb@1.5.2 - primer-buttons@2.5.4 - primer-core@6.9.0 - primer-forms@2.1.1 - primer-labels@1.5.6 - primer-layout@1.4.6 - primer-markdown@3.7.6 - primer-marketing-buttons@1.0.5 - primer-marketing-support@1.5.1 - primer-marketing-type@1.4.6 - primer-marketing-utilities@1.6.2 - primer-marketing@6.2.1 - primer-navigation@1.5.4 - primer-page-headers@1.4.6 - primer-page-sections@1.4.6 - primer-pagination@1.0.0 - primer-popover@0.1.0 - primer-product@5.6.3 - primer-subhead@1.0.4 - primer-support@4.5.3 - primer-table-object@1.4.6 - primer-tables@1.4.6 - primer-tooltips@1.5.4 - primer-truncate@1.4.6 - primer-utilities@4.10.0 - primer@10.5.0 - generator-primer-module@1.0.5 - stylelint-config-primer@2.2.6 - stylelint-selector-no-utility@1.8.6 |
||
---|---|---|
.. | ||
lib | ||
index.scss | ||
LICENSE | ||
package.json | ||
README.md | ||
stories.js |
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>