193 lines
4.9 KiB
Markdown
193 lines
4.9 KiB
Markdown
# Material for MkDocs
|
|
|
|
https://squidfunk.github.io/mkdocs-material/
|
|
|
|
|
|
|
|
### Icons + Emojis
|
|
|
|
https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
|
|
|
|
```yaml
|
|
markdown_extensions:
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
```
|
|
|
|
|
|
|
|
:material-material-design: [Material Design](https://materialdesignicons.com/)
|
|
|
|
:fontawesome-brands-font-awesome: [Font Awesome](https://fontawesome.com/search?m=free)
|
|
|
|
:octicons-mark-github-16: [Octicons](https://octicons.github.com/)
|
|
|
|
|
|
|
|
#### Emojis
|
|
|
|
```
|
|
:smile:
|
|
|
|
:angry:
|
|
|
|
:deer:
|
|
```
|
|
|
|
:smile:
|
|
|
|
:angry:
|
|
|
|
:deer:
|
|
|
|
|
|
|
|
#### Icons
|
|
|
|
```
|
|
:material-phone-classic:
|
|
|
|
:fontawesome-solid-phone-flip:
|
|
|
|
:octicons-megaphone-24:
|
|
```
|
|
|
|
:material-phone-classic:
|
|
|
|
:fontawesome-solid-phone-flip:
|
|
|
|
:octicons-megaphone-24:
|
|
|
|
|
|
|
|
|
|
### Lists
|
|
|
|
https://squidfunk.github.io/mkdocs-material/reference/lists/
|
|
|
|
```
|
|
markdown_extensions:
|
|
- def_list
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
```
|
|
|
|
#### Unordered lists
|
|
|
|
```title="List, unordered"
|
|
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur
|
|
accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh
|
|
lacinia sed. Aenean in finibus diam.
|
|
|
|
* Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
|
* Nam vulputate tincidunt fringilla.
|
|
* Nullam dignissim ultrices urna non auctor.
|
|
|
|
+ Vivamus venenatis
|
|
+ Morbi eget dapibus felis.
|
|
```
|
|
|
|
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur
|
|
accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh
|
|
lacinia sed. Aenean in finibus diam.
|
|
|
|
* Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
|
* Nam vulputate tincidunt fringilla.
|
|
* Nullam dignissim ultrices urna non auctor.
|
|
|
|
+ Vivamus venenatis
|
|
+ Morbi eget dapibus felis.
|
|
|
|
|
|
|
|
|
|
#### Ordered lists
|
|
|
|
```title="List, ordered"
|
|
1. Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis
|
|
sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis
|
|
nulla. Vivamus a pharetra leo.
|
|
|
|
1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet
|
|
quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a
|
|
ultricies libero efficitur sed.
|
|
|
|
2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet
|
|
rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
|
|
|
|
1. Mauris dictum mi lacus
|
|
2. Ut sit amet placerat ante
|
|
3. Suspendisse ac eros arcu
|
|
|
|
```
|
|
|
|
1. Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis
|
|
sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis
|
|
nulla. Vivamus a pharetra leo.
|
|
1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet
|
|
quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a
|
|
ultricies libero efficitur sed.
|
|
2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet
|
|
rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
|
|
|
|
1. Mauris dictum mi lacus
|
|
2. Ut sit amet placerat ante
|
|
3. Suspendisse ac eros arcu
|
|
|
|
|
|
|
|
#### Task lists
|
|
|
|
```title="Task list"
|
|
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
|
|
- [ ] Vestibulum convallis sit amet nisi a tincidunt
|
|
* [x] In hac habitasse platea dictumst
|
|
* [x] In scelerisque nibh non dolor mollis congue sed et metus
|
|
* [ ] Praesent sed risus massa
|
|
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
|
|
|
|
```
|
|
|
|
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
|
|
- [ ] Vestibulum convallis sit amet nisi a tincidunt
|
|
* [x] In hac habitasse platea dictumst
|
|
* [x] In scelerisque nibh non dolor mollis congue sed et metus
|
|
* [ ] Praesent sed risus massa
|
|
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
|
|
|
|
|
|
|
|
#### Definition lists
|
|
|
|
```title="Definition list"
|
|
`Lorem ipsum dolor sit amet`
|
|
|
|
: Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
|
|
tellus non sem sollicitudin, quis rutrum leo facilisis.
|
|
|
|
`Cras arcu libero`
|
|
|
|
: Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
|
|
ut eros sed sapien ullamcorper consequat. Nunc ligula ante.
|
|
|
|
Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
|
Nam vulputate tincidunt fringilla.
|
|
Nullam dignissim ultrices urna non auctor.
|
|
|
|
```
|
|
|
|
`Lorem ipsum dolor sit amet`
|
|
|
|
: Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
|
|
tellus non sem sollicitudin, quis rutrum leo facilisis.
|
|
|
|
`Cras arcu libero`
|
|
|
|
: Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
|
|
ut eros sed sapien ullamcorper consequat. Nunc ligula ante.
|
|
|
|
Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
|
|
Nam vulputate tincidunt fringilla.
|
|
Nullam dignissim ultrices urna non auctor.
|