Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve install guide for modern use like in scss. #39895

Open
damil42 opened this issue Apr 12, 2024 · 0 comments
Open

docs: Improve install guide for modern use like in scss. #39895

damil42 opened this issue Apr 12, 2024 · 0 comments
Labels

Comments

@damil42
Copy link

damil42 commented Apr 12, 2024

Importing bootstrap and bootstrap-icons in your project is very simple. Simpler than in docs. And some docs are missing in bootstrap-icons.

your.scss

@import 'bootstrap';
@import 'bootstrap-icons';

Done! 馃憤

We could improve the docs / quick guide:

-https://getbootstrap.com/docs/5.3/getting-started/vite/#import-bootstrap
-https://icons.getbootstrap.com/#install

Currently there is the following in bootstrap docs:

@import "bootstrap/scss/bootstrap";

Which also works, but not necessary for a quick guide. In detail guide we can go deeper.

And for bootstrap-icon there is nothing about scss use. Only CDN, etc. It would be great if we complete this with a short scss guide.

We could also just provide a small quick guide section for use in scss in readme. In this example I use the proper keyword use instead of import. Read more what is wrong with import. In the case you only import once, the import method is ok. But in general prefer use instead.

@use 'bootstrap';
@use 'bootstrap-icons';

Why this issue? Because I had some difficulty bringing this to life. I wish there is a quick guide for modern use like in Angular with scss, etc. Just a tiny section with the code block about would save a lot time. It's great that this is so easy to use. Let the users know. Less is more. Best practices.

@mdo mdo added the docs label Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants