mirror of
https://github.com/primer/css.git
synced 2024-09-21 13:51:52 +03:00
70 lines
1.9 KiB
Markdown
70 lines
1.9 KiB
Markdown
# Primer CSS / Branch Name
|
|
|
|
[](https://www.npmjs.org/package/primer-branch-name)
|
|
[](https://travis-ci.org/primer/primer-css)
|
|
|
|
> A nice, consistent way to display branch names.
|
|
|
|
This repository is a module of the full [primer-css][primer-css] repository.
|
|
|
|
## Install
|
|
|
|
This repository is distributed with [npm]. After [installing npm][install-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][sass] (SCSS) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.
|
|
|
|
```scss
|
|
@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
|
|
|
|
<!-- %docs
|
|
title: Branch name
|
|
status: Stable
|
|
-->
|
|
|
|
Branch names can be a link name or not:
|
|
|
|
```html
|
|
<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:
|
|
|
|
```html
|
|
<span class="branch-name">
|
|
<%= octicon("git-branch") width:16 height:16 %>
|
|
a_new_feature_branch
|
|
</span>
|
|
```
|
|
|
|
<!-- %enddocs -->
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE) © [GitHub](https://github.com/)
|
|
|
|
[primer-css]: https://github.com/primer/primer
|
|
[docs]: http://primercss.io/
|
|
[npm]: https://www.npmjs.com/
|
|
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
|
|
[sass]: http://sass-lang.com/
|