bootstrap-icons 1.10.2 → 1.10.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2019-2021 The Bootstrap Authors
3
+ Copyright (c) 2019-2023 The Bootstrap Authors
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -20,7 +20,7 @@
20
20
  <br>
21
21
  </p>
22
22
 
23
- [![Bootstrap Icons preview](https://github.com/twbs/icons/blob/main/.github/preview.png)](https://icons.getbootstrap.com)
23
+ [![Bootstrap Icons preview](https://github.com/twbs/icons/blob/main/.github/preview.png)](https://icons.getbootstrap.com/)
24
24
 
25
25
  ## Install
26
26
 
@@ -36,7 +36,7 @@ For those [using Packagist](https://packagist.org/packages/twbs/bootstrap-icons)
36
36
  composer require twbs/bootstrap-icons
37
37
  ```
38
38
 
39
- [Also available in Figma.](https://www.figma.com/community/file/1042482994486402696/Bootstrap-Icons)
39
+ [Also available in Figma](https://www.figma.com/community/file/1042482994486402696/Bootstrap-Icons).
40
40
 
41
41
  ## Usage
42
42
 
@@ -47,11 +47,12 @@ Depending on your setup, you can include Bootstrap Icons in a handful of ways.
47
47
  - Use the SVG sprite
48
48
  - Include via CSS
49
49
 
50
- [See the docs for more information.](https://icons.getbootstrap.com/#usage)
50
+ [See the docs for more information](https://icons.getbootstrap.com/#usage).
51
51
 
52
52
  ## Development
53
53
 
54
- [![Build Status](https://github.com/twbs/icons/workflows/Tests/badge.svg)](https://github.com/twbs/icons/actions?workflow=Tests)
54
+ [![Build Status](https://img.shields.io/github/actions/workflow/status/twbs/icons/test.yml?branch=main&label=Tests&logo=github)](https://github.com/twbs/icons/actions/workflows/test.yml?query=workflow%3ATests+branch%3Amain)
55
+ [![npm version](https://img.shields.io/npm/v/bootstrap-icons?logo=npm&logoColor=fff)](https://www.npmjs.com/package/bootstrap-icons)
55
56
 
56
57
  Clone the repo, install dependencies, and start the Hugo server locally.
57
58
 
@@ -66,24 +67,26 @@ Then open `http://localhost:4000` in your browser.
66
67
 
67
68
  ### npm scripts
68
69
 
69
- Here are some key scripts you'll use during development. Be sure to look to our `package.json` for a complete list of scripts.
70
+ 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.
70
71
 
71
- | Script | Description |
72
- | --- | --- |
73
- | `start` | Alias for running `docs-serve` |
74
- | `docs-serve` | Starts a local Hugo server |
75
- | `pages` | Generates permalink pages for each icon with template Markdown |
76
- | `icons` | Processes and optimizes SVGs in `icons` directory |
72
+ | Script | Description |
73
+ |--------------|-------------------------------------------------------------------------------|
74
+ | `start` | Alias for running `docs-serve` |
75
+ | `docs-serve` | Starts a local Hugo server |
76
+ | `pages` | Generates permalink pages for each icon with template Markdown |
77
+ | `icons` | Processes and optimizes SVGs in `icons` directory, generates fonts and sprite |
77
78
 
78
79
  ## Adding SVGs
79
80
 
80
81
  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:
81
82
 
82
83
  1. Optimize our SVGs with SVGO.
83
- 2. Modify the SVGs source HTML, removing all attributes before setting new attributes and values in our preferred order.
84
+ 2. Modify the SVGs source code, removing all attributes before setting new attributes and values in our preferred order.
84
85
 
85
86
  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.
86
87
 
88
+ **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.
89
+
87
90
  ## Publishing
88
91
 
89
92
  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.