https://github.com/jonathanschndr/bootstrap-icons-npm-starter
:sparkles: npm starter to include custom bootstrap-icons
https://github.com/jonathanschndr/bootstrap-icons-npm-starter
Last synced: 2 months ago
JSON representation
:sparkles: npm starter to include custom bootstrap-icons
- Host: GitHub
- URL: https://github.com/jonathanschndr/bootstrap-icons-npm-starter
- Owner: JonathanSchndr
- Created: 2022-05-10T12:59:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-19T07:15:17.000Z (about 3 years ago)
- Last Synced: 2025-02-05T06:23:41.304Z (4 months ago)
- Language: HTML
- Size: 873 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :dolphin: Bootstrap icons npm starter
This template allows you to easily version boostrap icons and your own icons with npm at the same time.
## :rocket: Usage
After cloning the repository you can place your own icons in the icons folder (if you don't have any skip this step).
Then run `npm install`, your own icons will now be extended with the bootstrap icons. It will create a symlink dist folder where your font will be created. alternatively, you can also run an `npm run icon:generate` later if your own icons have changed.
## :scroll: Documentation
Run `npm run icon:docs` to create the documentation for your icons & the bootstrap icons.
## ⚙️ Configuration
The config folder does not need to be changed and is based on bootstrap icon version 1.8.1. if you have specific requirements, you may be able to solve them here. currently, the bootstrap recommendation is stored there.
## :interrobang: Troubleshooting
If you use a new version of the bootstrap icons, you might have to recreate the config folder as well. You can find the current config files in the official bootstrap-icons repo. feel free to create a pull request for it. the version of this package always corresponds to the supported version of the `bootstrap-icons`.