\n\n[](https://icons.getbootstrap.com/)\n\n## Install\n\nBootstrap 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.\n\n```shell\nnpm i bootstrap-icons\n```\n\nFor those [using Packagist](https://packagist.org/packages/twbs/bootstrap-icons), you can also install Bootstrap Icons via Composer:\n\n```shell\ncomposer require twbs/bootstrap-icons\n```\n\n[Also available in Figma](https://www.figma.com/community/file/1042482994486402696/Bootstrap-Icons).\n\n## Usage\n\nDepending on your setup, you can include Bootstrap Icons in a handful of ways.\n\n- Copy-paste SVGs as embedded HTML\n- Reference via `` element\n- Use the SVG sprite\n- Include via CSS\n\n[See the docs for more information](https://icons.getbootstrap.com/#usage).\n\n## Development\n\n[](https://github.com/twbs/icons/actions/workflows/test.yml?query=workflow%3ATests+branch%3Amain)\n[](https://www.npmjs.com/package/bootstrap-icons)\n\nClone the repo, install dependencies, and start the Hugo server locally.\n\n```shell\ngit clone https://github.com/twbs/icons/\ncd icons\nnpm i\nnpm start\n```\n\nThen open `http://localhost:4000` in your browser.\n\n### npm scripts\n\nHere are some key scripts you'll use during development. Be sure to look to our `package.json` or `npm run` output for a complete list of scripts.\n\n| Script | Description |\n|--------------|-------------------------------------------------------------------------------|\n| `start` | Alias for running `docs-serve` |\n| `docs-serve` | Starts a local Hugo server |\n| `pages` | Generates permalink pages for each icon with template Markdown |\n| `icons` | Processes and optimizes SVGs in `icons` directory, generates fonts and sprite |\n\n## Adding SVGs\n\nIcons 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:\n\n1. Optimize our SVGs with SVGO.\n2. Modify the SVGs source code, removing all attributes before setting new attributes and values in our preferred order.\n\nUse `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.\n\n**Warning**: Please exclude any auto-generated files, like `font/**` and `bootstrap-icons.svg` from your branch because they cause conflicts, and we generally update the dist files before a release.\n\n## Publishing\n\nDocumentation 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.\n\n## License\n\n[MIT](LICENSE)\n\n## Author\n\n[@mdo](https://github.com/mdo)\n","readmeFilename":"README.md","users":{}}
![\"Bootstrap](\"https://getbootstrap.com/docs/5.2/assets/brand/bootstrap-logo-shadow.png\"){kind=logo}
\n \n