Added button reference documentation

This commit is contained in:
squidfunk 2020-07-27 12:32:24 +02:00
parent 556dcc71c0
commit cf037cfccf
2 changed files with 84 additions and 0 deletions

83
docs/reference/buttons.md Normal file
View File

@ -0,0 +1,83 @@
---
template: overrides/main.html
---
# Buttons
Material for MkDocs provides dedicated styles for primary and secondary buttons
that can be added to any link, `label` or `button` element. This is especially
useful for documents or landing pages with dedicated _call-to-actions_.
## Configuration
### Attribute List
The [Attribute List][1] extension, which is part of the standard Markdown
library, allows to __add HTML attributes and CSS classes to Markdown elements__,
and can be enabled via `mkdocs.yml`
``` yaml
markdown_extensions:
- attr_list
```
[1]: https://python-markdown.github.io/extensions/attr_list/
## Usage
### Adding buttons
When the [Attribute List][2] extension is enabled, any clickable element can be
converted into a button by adding the `.md-button` CSS class, which will receive
the selected [primary color][3].
_Example_:
``` markdown
[Subscribe to our mailing list](#){: .md-button }
```
_Result_:
[Subscribe to our mailing list][4]{: .md-button }
[2]: #attribute-list
[3]: ../setup/changing-the-colors.md#primary-color
[4]: javascript:app.dialog$.next("Done!")
### Adding primary buttons
If you want to display a filled, primary button (like on the [landing page][5]
of Material for MkDocs), add both the `.md-button` and `.md-button--primary`
CSS classes.
_Example_:
``` markdown
[Subscribe to our mailing list](#){: .md-button .md-button--primary }
```
_Result_:
[Subscribe to our mailing list][4]{: .md-button .md-button--primary }
[5]: ../index.md
### Adding icon buttons
Of course, icons can be added to both types of buttons by using the [regular
icon syntax][6] and referencing a valid path to [any icon bundled with the
theme][7].
_Example_:
``` markdown
[Submit :fontawesome-solid-paper-plane:](#){: .md-button .md-button--primary }
```
_Result_:
[Submit :fontawesome-solid-paper-plane:][4]{: .md-button .md-button--primary }
[6]: icons-emojis.md#using-icons
[7]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons

View File

@ -165,6 +165,7 @@ nav:
#- Adding a landing page: setup/adding-a-landing-page.md
- Reference:
- Admonitions: reference/admonitions.md
- Buttons: reference/buttons.md
- Code blocks: reference/code-blocks.md
- Content tabs: reference/content-tabs.md
- Footnotes: reference/footnotes.md