mirror of
https://github.com/primer/css.git
synced 2024-12-24 22:53:58 +03:00
48 lines
1.6 KiB
Markdown
48 lines
1.6 KiB
Markdown
# Primer Breadcrumb Navigation
|
||
|
||
[](https://www.npmjs.org/package/primer-breadcrumb)
|
||
[](https://travis-ci.org/primer/primer)
|
||
|
||
> Breadcrumb navigation for GitHub's pages with parents / grandparents.
|
||
|
||
This repository is a module of the full [primer][primer] repository.
|
||
|
||
## Documentation
|
||
|
||
<!-- %docs
|
||
title: Breadcrumbs
|
||
status: Stable
|
||
-->
|
||
|
||
Breadcrumbs are used to show taxonomical context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages. Breadcrumbs are most appropriate on pages that:
|
||
|
||
- Are many levels deep on a site
|
||
- Do not have a section-level navigation
|
||
- May need the ability to quickly go back to the previous (parent) page
|
||
|
||
#### Usage
|
||
|
||
```html title="Breadcrumb"
|
||
<nav aria-label="Breadcrumb">
|
||
<ol>
|
||
<li class="breadcrumb-item text-small"><a href="/business">Business</a></li>
|
||
<li class="breadcrumb-item text-small"><a href="/business/customers">Customers</a></li>
|
||
<li class="breadcrumb-item breadcrumb-item-selected text-small text-gray" aria-current="page">MailChimp</li>
|
||
</ol>
|
||
</nav>
|
||
```
|
||
|
||
<!-- %enddocs -->
|
||
|
||
## License
|
||
|
||
MIT © [GitHub](https://github.com/)
|
||
|
||
[primer]: https://github.com/primer/primer
|
||
[primer-support]: https://github.com/primer/primer-support
|
||
[support]: https://github.com/primer/primer-support
|
||
[docs]: http://primer.github.io/
|
||
[npm]: https://www.npmjs.com/
|
||
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
|
||
[sass]: http://sass-lang.com/
|