學習
Admonitions(警告) - Material for MkDocs (wdk-docs.github.io)
提示 - Material for MkDocs 中文文檔 (llango.com)
Buttons(按鈕) - Material for MkDocs (wdk-docs.github.io)
建議去看這些網站,更為詳細。
常用功能
便利貼
??
開啟
markdown_extensions:- admonition #便利貼- pymdownx.details #塊折疊- pymdownx.superfences #塊嵌套
語法格式
!!! <樣式> ["標題"]內容段落。
觸發條件:用三個英文感嘆號!!!
?表示使用便利貼
樣式:支持note、tip、Info等十多個樣式。
標題樣式:不寫標題是默認,寫""
?是無標題。??
范圍:從!!!
?起到第一個不縮進的行結束。
!!! tip示例文字:Admonition 擴展是標準 Markdown 庫的一部分,與 Material for MkDocs 集成,可以通過以下方式啟用:mkdocs.yml
樣式預覽
??
更多樣式參考附錄
Annotations(注解)
開啟
markdown_extensions:- attr_list- md_in_html- pymdownx.superfences
演示
??
按鈕
開啟
markdown_extensions:- attr_list # 按鈕- pymdownx.emoji: # 圖標、emojiemoji_index: !!python/name:materialx.emoji.twemojiemoji_generator: !!python/name:materialx.emoji.to_svg
語法
-
默認按鈕
[標題](URL){按鈕樣式}
? -
帶圖標的按鈕
[標題 :圖標樣式:](URL){按鈕樣式}
?
是不是眼熟?就是在md的鏈接語法上添加了樣式。示例
普通按鈕
markdown [按鈕標題](跳轉URL){ .md-button } 主按鈕
markdown [按鈕標題](跳轉URL){ .md-button .md-button--primary }帶圖標的按鈕
markdown [按鈕標題 :fontawesome-solid-paper-plane:](URL){: .md-button .md-button--primary }
演示(只能在靜態網站中展示,CSDN等平臺不支持)
普通按鈕
靈魂io - 測試站{ .md-button }
主按鈕
靈魂io - 測試站{ .md-button .md-button–primary }
帶圖標的按鈕
靈魂io - 測試站 :fontawesome-solid-paper-plane:{ .md-button .md-button–primary }
代碼塊
啟用
markdown_extensions:- pymdownx.highlight: # 代碼高亮anchor_linenums: true- pymdownx.inlinehilite- pymdownx.snippets- pymdownx.superfences- pymdownx.keys # 樣式:鍵盤按鍵
代碼塊標題
??
效果
??
注釋折疊、展開
??
效果
??
代碼塊選項卡(用的是選項卡功能,不是代碼塊功能)
??
高亮指定的行
??
鍵盤樣式
??
以及導入外部文件
選項卡
開啟
選項卡
markdown_extensions:- pymdownx.superfences- pymdownx.tabbed:alternate_style: true
選項卡鏈接
theme:features:- content.tabs.link
寫法 從===
?開始,內容要縮進,遇到===
?則合并選項卡,遇到既不是===
?又不是縮進
?的行則結束。
??
效果
??
!!! note “選項卡的范圍”
從第一個===
? 開始,縮進的行、空行、以===
? 開頭的行都屬于選項卡!
預覽(僅支持靜態網站,CSDN等平臺不支持)
=== “C”
?```c
#include <stdio.h>int main(void) { printf("Hello world!\n"); return 0;
}
?```
=== “C++”
?```c++
#include <iostream>int main(void) { std::cout << "Hello world!" << std::endl; return 0;
}
?```
=== “Tab 1”
Markdown content.
Multiple paragraphs.
=== “Tab 2”
More Markdown content.
- list item a
- list item b
=== “Not Me”
Markdown content.
Multiple paragraphs.
===+ “Select Me”
More Markdown content.
- list item a
- list item b
=== “Not Me Either”
Another Tab
清單
開啟
markdown_extensions:- pymdownx.tasklist: # 開啟功能clickable_checkbox: true # 允許打勾和取消,但不是持續的。custom_checkbox: true # 將task的方框修改為圓形。
編寫
??
默認效果
??
custom_checkbox 效果
??
?