-
-
Notifications
You must be signed in to change notification settings - Fork 383
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bed5092
commit ae33487
Showing
2,299 changed files
with
141,182 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2019-2023 The Bootstrap Authors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2019-2021 The Bootstrap Authors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
<p align="center"> | ||
<a href="https://v5.getbootstrap.com/"> | ||
<img src="https://v5.getbootstrap.com/docs/5.0/assets/brand/bootstrap-logo-shadow.png" alt="Bootstrap logo" width="200" height="165"> | ||
</a> | ||
</p> | ||
|
||
<h3 align="center">Bootstrap Icons</h3> | ||
|
||
<p align="center"> | ||
Official open source SVG icon library for Bootstrap with over 1,800 icons. | ||
<br> | ||
<a href="https://icons.getbootstrap.com/"><strong>Explore Bootstrap Icons »</strong></a> | ||
<br> | ||
<br> | ||
<a href="https://getbootstrap.com/">Bootstrap</a> | ||
· | ||
<a href="https://themes.getbootstrap.com/">Themes</a> | ||
· | ||
<a href="https://blog.getbootstrap.com/">Blog</a> | ||
<br> | ||
</p> | ||
|
||
[![Bootstrap Icons preview](https://github.com/twbs/icons/blob/main/.github/preview.png)](https://icons.getbootstrap.com) | ||
|
||
## Install | ||
|
||
Bootstrap Icons are packaged up and published to npm. We only include the processed SVGs in this package—it's up to you and your team to implement. [Read our docs](https://icons.getbootstrap.com/) for usage instructions. | ||
|
||
```shell | ||
npm i bootstrap-icons | ||
``` | ||
|
||
For those [using Packagist](https://packagist.org/packages/twbs/bootstrap-icons), you can also install Bootstrap Icons via Composer: | ||
|
||
```shell | ||
composer require twbs/bootstrap-icons | ||
``` | ||
|
||
[Also available in Figma.](https://www.figma.com/community/file/1042482994486402696/Bootstrap-Icons) | ||
|
||
## Usage | ||
|
||
Depending on your setup, you can include Bootstrap Icons in a handful of ways. | ||
|
||
- Copy-paste SVGs as embedded HTML | ||
- Reference via `<img>` element | ||
- Use the SVG sprite | ||
- Include via CSS | ||
|
||
[See the docs for more information.](https://icons.getbootstrap.com/#usage) | ||
|
||
## Development | ||
|
||
[![Build Status](https://github.com/twbs/icons/workflows/Tests/badge.svg)](https://github.com/twbs/icons/actions?workflow=Tests) | ||
|
||
Clone the repo, install dependencies, and start the Hugo server locally. | ||
|
||
```shell | ||
git clone https://github.com/twbs/icons/ | ||
cd icons | ||
npm i | ||
npm start | ||
``` | ||
|
||
Then open `http://localhost:4000` in your browser. | ||
|
||
### npm scripts | ||
|
||
Here are some key scripts you'll use during development. Be sure to look to our `package.json` for a complete list of scripts. | ||
|
||
| Script | Description | | ||
| --- | --- | | ||
| `start` | Alias for running `docs-serve` | | ||
| `docs-serve` | Starts a local Hugo server | | ||
| `pages` | Generates permalink pages for each icon with template Markdown | | ||
| `icons` | Processes and optimizes SVGs in `icons` directory | | ||
|
||
## Adding SVGs | ||
|
||
Icons are typically only added by @mdo, but exceptions can be made. New glyphs are designed in Figma first on a 16x16px grid, then exported as flattened SVGs with `fill` (no stroke). Once a new SVG icon has been added to the `icons` directory, we use an npm script to: | ||
|
||
1. Optimize our SVGs with SVGO. | ||
2. Modify the SVGs source HTML, removing all attributes before setting new attributes and values in our preferred order. | ||
|
||
Use `npm run icons` to run the script, run `npm run pages` to build permalink pages, complete those pages, and, finally, commit the results in a new branch for updating. | ||
|
||
## Publishing | ||
|
||
Documentation is published automatically when a new Git tag is published. See our [GitHub Actions](https://github.com/twbs/icons/tree/main/.github/workflows) and [`package.json`](https://github.com/twbs/icons/blob/main/package.json) for more information. | ||
|
||
## License | ||
|
||
MIT | ||
|
||
## Author | ||
|
||
[@mdo](https://github.com/mdo) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.