diff --git a/docs/badges_buttons.md b/docs/badges_buttons.md index 9eeaace..9a4c6ac 100644 --- a/docs/badges_buttons.md +++ b/docs/badges_buttons.md @@ -60,7 +60,29 @@ See [Bootstrap badges](https://getbootstrap.com/docs/5.0/components/badge/) for ## Buttons -Buttons allow users to navigate to external (`button-link`) / internal (`button-ref`) links with a single tap. +Buttons in Sphinx Design are actually links: + +- Links that can be styled to look like + [Bootstrap buttons](https://getbootstrap.com/docs/5.0/components/buttons/) +- Links that are either external (`button-link`) or internal (`button-ref`) + +Most of the time, you should create links using the link syntax for the language +you've chosen: + +- [Markdown/MyST links and cross-references](https://myst-parser.readthedocs.io/en/latest/syntax/cross-referencing.html#examples) +- [rST links and cross-references](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks) + +Sometimes, though, you may want to call attention to a particular link or set of +links, or set them apart visually from other links on the site. + +:::{admonition} Note on accessibility + +Despite the name, `button-link` and `button-ref` do **not** convert to +`