Mention Boostrap Icons version in Documentation to make it less ambiguous

[lindsayevanslee]

What would you like to do?

Report an issue on quarto.org

Description

In the documentation on Nav Items for _quarto.yml, it says that you can visit https://icons.getbootstrap.com/ to see the list of available icons. At this site, it shows you the latest version of Bootstrap icons, currently 1.13.1. However in the latest version of Quarto (1.7.31, which I installed today), I can see in the header of the bootstrap-icons.css file that is automatically rendered in my Quarto blog that the current version of Bootstrap Icons used by Quarto is 1.11.1. Therefore not all of the icons shown on this page are actually available for use in Quarto today.

I submitted a feature request to update the Bootstrap Icons version used by Quarto. However until this is implemented, the documentation should be updated to make it clear which version of Bootstrap Icons is used and to indicate to users how they can see an accurate list of available icons.

Thank you!

[cderv]

Thanks for the report. This documentation comes from our Schema. So the question for us is: can we make this part of the documentation aware of the bundled Bootstrap version? 🤔

quarto-cli/src/resources/schema/definitions.yml

Lines 123 to 129 in 432c04f

	icon:
	string:
	description:
	short: Name of bootstrap icon (e.g. `github`, `twitter`, `share`)
	long: |
	Name of bootstrap icon (e.g. `github`, `twitter`, `share`)
	See <https://icons.getbootstrap.com/> for a list of available icons

Just a heads up also that a Quarto Extensions exists for Bootstrap Icons

• https://github.com/shafayetShafee/bsicons

It may be quicker / easier to update there if this is still maintained.

[cderv]

Regarding documentation, we can probably more easily update the main website using a project variable for the version (or reading quarto configuration files)

It seems BSICONS version is synced differently than Bootstrap

quarto-cli/configuration

Line 32 in 432c04f

export BOOTSTRAP_FONT=1.11.1

We do mention this link in several places

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/manuscripts/components.qmd#L105

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/output-formats/html-basics.qmd#L98

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/output-formats/html-multi-format.qmd#L77

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/reference/formats/dashboard.qmd#L155

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/websites/website-about.qmd#L127

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/websites/website-navigation.qmd#L79

https://github.com/quarto-dev/quarto-web/blob/610f2a4dd225493666ea7908ea62d356e28ba0f6/docs/websites/website-tools.qmd#L53

There is probably room to reduce all that duplication and integrate the version in the description and link 🤔

What do you think @cwickham ?