diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-04-07 12:22:26 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-04-07 12:22:26 +0000 |
| commit | d50fca7dd40f596ebb8b50cd9c4140857f2a0637 (patch) | |
| tree | a8b40991dcab905c34658c3d860ad7e0a4554c9d /README.md | |
| parent | Releasing debian version 1.10.3+dfsg-1. (diff) | |
| download | bootstrap-icons-d50fca7dd40f596ebb8b50cd9c4140857f2a0637.tar.xz bootstrap-icons-d50fca7dd40f596ebb8b50cd9c4140857f2a0637.zip | |
Merging upstream version 1.10.4+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 15 insertions, 12 deletions
@@ -20,7 +20,7 @@ <br> </p> -[](https://icons.getbootstrap.com) +[](https://icons.getbootstrap.com/) ## Install @@ -36,7 +36,7 @@ For those [using Packagist](https://packagist.org/packages/twbs/bootstrap-icons) composer require twbs/bootstrap-icons ``` -[Also available in Figma.](https://www.figma.com/community/file/1042482994486402696/Bootstrap-Icons) +[Also available in Figma](https://www.figma.com/community/file/1042482994486402696/Bootstrap-Icons). ## Usage @@ -47,11 +47,12 @@ Depending on your setup, you can include Bootstrap Icons in a handful of ways. - Use the SVG sprite - Include via CSS -[See the docs for more information.](https://icons.getbootstrap.com/#usage) +[See the docs for more information](https://icons.getbootstrap.com/#usage). ## Development -[](https://github.com/twbs/icons/actions?workflow=Tests) +[](https://github.com/twbs/icons/actions/workflows/test.yml?query=workflow%3ATests+branch%3Amain) +[](https://www.npmjs.com/package/bootstrap-icons) Clone the repo, install dependencies, and start the Hugo server locally. @@ -66,24 +67,26 @@ 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. +Here 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. -| 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 | +| 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, generates fonts and sprite | ## 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. +2. Modify the SVGs source code, 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. +**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. + ## 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. |