knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Define the admonition boxes we use (#4122)

This commit is contained in:
Samia Nneji 2021-08-18 14:57:08 +01:00 committed by GitHub
parent 978c926265
commit f3ee88ef0a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/help/contributor/mkdocs-contributor-guide.md
View File

@ -209,17 +209,38 @@ Snippets can handle recursive file inclusion. And if Snippets encounters the sam
For more info, see: [https://facelessuser.github.io/pymdown-extensions/extensions/snippets/](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/)
### Admonitions
=== "Admontion"
!!! tip
Admonitions (like this one) are a great way to highlight important bits of information for readers.
=== "Formating"
We use the following admonition boxes only. Use admonitions sparingly; too many admonitions can be distracting.
=== "Admonitions"
!!! note
A Note contains information that is useful, but not essential.
A reader can skip a note without bypassing required information.
If the information suggests an action to take, use a tip instead.
!!! tip
A Tip suggests an helpful, but not mandatory, action to take.
!!! warning
A Warning draws attention to potential trouble.
=== "Formatting"
```
!!! note
A Note contains information that is useful, but not essential.
A reader can skip a note without bypassing required information.
If the information suggests an action to take, use a tip instead.
```
```
!!! tip
Admonitions (like this one) are a great way to highlight important bits of information for readers.
A Tip suggests an helpful, but not mandatory, action to take.
```
For formatting (including more advanced Admonitions), see: [https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)
```
!!! warning
A Warning draws attention to potential trouble.
```
### Icons and Emojis
Material for MkDocs supports using Material Icons and Emojis using easy shortcodes.