|
| 1 | +# mkdocs-material |
| 2 | + |
| 3 | +## markdown 扩展效果 |
| 4 | + |
| 5 | +### 警告 |
| 6 | + |
| 7 | +- <https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types> |
| 8 | + |
| 9 | +!!! note |
| 10 | + |
| 11 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 12 | + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor |
| 13 | + massa, nec semper lorem quam in massa. |
| 14 | + |
| 15 | +!!! example |
| 16 | + |
| 17 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 18 | + |
| 19 | +!!! success |
| 20 | + |
| 21 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 22 | + |
| 23 | +!!! tip |
| 24 | + |
| 25 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 26 | + |
| 27 | +!!! question |
| 28 | + |
| 29 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 30 | + |
| 31 | +!!! warning |
| 32 | + |
| 33 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 34 | + |
| 35 | +!!! danger |
| 36 | + |
| 37 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 38 | + |
| 39 | +!!! bug |
| 40 | + |
| 41 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 42 | + |
| 43 | +> 可折叠警告 |
| 44 | +
|
| 45 | +??? note |
| 46 | + |
| 47 | + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod |
| 48 | + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor |
| 49 | + massa, nec semper lorem quam in massa. |
| 50 | + |
| 51 | +### 注释+警告 |
| 52 | + |
| 53 | +- <https://squidfunk.github.io/mkdocs-material/reference/annotations/> |
| 54 | + |
| 55 | +> 示例: |
| 56 | +
|
| 57 | +!!! note annotate "Phasellus posuere in sem ut cursus (1)" |
| 58 | + |
| 59 | + Lorem ipsum dolor sit amet, (2) consectetur adipiscing elit. Nulla et |
| 60 | + euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo |
| 61 | + purus auctor massa, nec semper lorem quam in massa. |
| 62 | + |
| 63 | +1. :man_raising_hand: I'm an annotation! |
| 64 | +2. :woman_raising_hand: I'm an annotation as well! |
| 65 | + |
| 66 | +### 表情符号 |
| 67 | + |
| 68 | +- <https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#with-colors-mkdocsyml> |
| 69 | + |
| 70 | +:smile: |
| 71 | + |
| 72 | +> 注意: 使用了自定义样式!!! |
| 73 | +
|
| 74 | +:fontawesome-brands-youtube:{ .youtube } |
| 75 | + |
| 76 | +:octicons-heart-fill-24:{ .heart } |
| 77 | + |
| 78 | +### 网格 |
| 79 | + |
| 80 | +- <https://squidfunk.github.io/mkdocs-material/reference/grids/#using-generic-grids-unordered-list> |
| 81 | + |
| 82 | +<div class="grid cards" markdown> |
| 83 | + |
| 84 | +- :fontawesome-brands-html5: __HTML__ for content and structure |
| 85 | +- :fontawesome-brands-js: __JavaScript__ for interactivity |
| 86 | +- :fontawesome-brands-css3: __CSS__ for text running out of boxes |
| 87 | +- :fontawesome-brands-internet-explorer: __Internet Explorer__ ... huh? |
| 88 | + |
| 89 | +</div> |
| 90 | + |
| 91 | +- 示例2 |
| 92 | + |
| 93 | +<div class="grid" markdown> |
| 94 | + |
| 95 | +=== "Unordered list" |
| 96 | + |
| 97 | + * Sed sagittis eleifend rutrum |
| 98 | + * Donec vitae suscipit est |
| 99 | + * Nulla tempor lobortis orci |
| 100 | + |
| 101 | +=== "Ordered list" |
| 102 | + |
| 103 | + 1. Sed sagittis eleifend rutrum |
| 104 | + 2. Donec vitae suscipit est |
| 105 | + 3. Nulla tempor lobortis orci |
| 106 | + |
| 107 | +``` title="Content tabs" |
| 108 | +=== "Unordered list" |
| 109 | +
|
| 110 | + * Sed sagittis eleifend rutrum |
| 111 | + * Donec vitae suscipit est |
| 112 | + * Nulla tempor lobortis orci |
| 113 | +
|
| 114 | +=== "Ordered list" |
| 115 | +
|
| 116 | + 1. Sed sagittis eleifend rutrum |
| 117 | + 2. Donec vitae suscipit est |
| 118 | + 3. Nulla tempor lobortis orci |
| 119 | +``` |
| 120 | + |
| 121 | +</div> |
| 122 | + |
| 123 | +### 格式化 |
| 124 | + |
| 125 | +- <https://squidfunk.github.io/mkdocs-material/reference/formatting/> |
| 126 | + |
| 127 | +> 示例: |
| 128 | +
|
| 129 | +- ==This was marked (highlight)== |
| 130 | +- ^^This was inserted (underline)^^ |
| 131 | +- ~~This was deleted (strikethrough)~~ |
| 132 | + |
| 133 | +> 键盘按键: |
| 134 | +
|
| 135 | +++ctrl+alt+del++ |
| 136 | + |
| 137 | +### 选项卡 |
| 138 | + |
| 139 | +- <https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage> |
| 140 | + |
| 141 | +=== "C" |
| 142 | + |
| 143 | + ``` c |
| 144 | + #include <stdio.h> |
| 145 | + |
| 146 | + int main(void) { |
| 147 | + printf("Hello world!\n"); |
| 148 | + return 0; |
| 149 | + } |
| 150 | + ``` |
| 151 | + |
| 152 | +=== "C++" |
| 153 | + |
| 154 | + ``` c++ |
| 155 | + #include <iostream> |
| 156 | + |
| 157 | + int main(void) { |
| 158 | + std::cout << "Hello world!" << std::endl; |
| 159 | + return 0; |
| 160 | + } |
| 161 | + ``` |
| 162 | + |
| 163 | +### 带有警告 |
| 164 | + |
| 165 | +!!! example |
| 166 | + |
| 167 | + === "Unordered List" |
| 168 | + |
| 169 | + ``` markdown |
| 170 | + * Sed sagittis eleifend rutrum |
| 171 | + * Donec vitae suscipit est |
| 172 | + * Nulla tempor lobortis orci |
| 173 | + ``` |
| 174 | + |
| 175 | + === "Ordered List" |
| 176 | + |
| 177 | + ``` markdown |
| 178 | + 1. Sed sagittis eleifend rutrum |
| 179 | + 2. Donec vitae suscipit est |
| 180 | + 3. Nulla tempor lobortis orci |
| 181 | + ``` |
| 182 | + |
| 183 | +### 图表效果 |
| 184 | + |
| 185 | +- <https://squidfunk.github.io/mkdocs-material/reference/diagrams/> |
| 186 | + |
| 187 | +``` mermaid |
| 188 | +graph LR |
| 189 | + A[Start] --> B{Error?}; |
| 190 | + B -->|Yes| C[Hmm...]; |
| 191 | + C --> D[Debug]; |
| 192 | + D --> B; |
| 193 | + B ---->|No| E[Yay!]; |
| 194 | +``` |
0 commit comments