MkDocs Markdown Snippets - Danh Sách Keyword

📋 Metadata & Frontmatter

KeywordChức năng
metaTạo metadata block cho MkDocs Material (title, description, icon, status, etc.)
blogTạo frontmatter cho blog post (date, categories, tags, authors, draft)
tags:Thêm tags trong frontmatter

🎨 Admonitions (Callouts)

KeywordChức năng
noteAdmonition dạng Note
abstractAdmonition dạng Abstract/Summary
infoAdmonition dạng Info
tipAdmonition dạng Tip/Hint
successAdmonition dạng Success/Check
questionAdmonition dạng Question/Help
warningAdmonition dạng Warning/Caution
failureAdmonition dạng Failure/Fail
dangerAdmonition dạng Danger/Error
bugAdmonition dạng Bug
exampleAdmonition dạng Example
quoteAdmonition dạng Quote/Cite
???Admonition có thể thu gọn (collapsed)
???+Admonition đã mở sẵn (expanded)
inlineAdmonition inline bên trái
inline-endAdmonition inline bên phải
calloutCallout theo style Obsidian

💻 Code Blocks

KeywordChức năng
```Code block cơ bản với syntax highlighting
codetCode block có title
codelCode block có line numbers
codehCode block có highlight lines
codefCode block đầy đủ (title + linenums + highlight)
codeaCode block có annotations (chú thích)

📑 Content Organization

KeywordChức năng
===Content tabs (tabbed content)
tabscodeContent tabs với code blocks
gridGrid cards layout với icons
gridgGeneric grid layout (2 cột)
2colTwo column layout với headings

📊 Diagrams (Mermaid)

KeywordChức năng
mermaidFlowchart diagram
sequenceSequence diagram
classClass diagram
stateState diagram
erdiagramEntity-Relationship diagram
ganttGantt chart
piePie chart

📋 Tables

KeywordChức năng
tableTable cơ bản
tableaTable với column alignment (left/center/right)
tablesSortable table (có thể sắp xếp)

center table

MethodDescription
GETFetch resource
PUTUpdate resource
DELETEDelete resource
KeywordChức năng
btnButton link cơ bản
btnpPrimary button (nổi bật hơn)
btniButton có icon
linktLink có tooltip
linkeExternal link (mở tab mới)
[[Wikilink (style Obsidian)
`[[`

🖼️ Images

KeywordChức năng
imgImage cơ bản
imgcImage với caption (chú thích)
imgaImage có alignment (left/right)
imglImage với lazy loading
imgwImage với custom width

📝 Text Formatting

KeywordChức năng
==Highlight text (đánh dấu)
++Keyboard keys
~Subscript (chỉ số dưới)
^Superscript (chỉ số trên)
`
{++Critic addition (đánh dấu thêm)
{--Critic deletion (đánh dấu xóa)
{~~Critic substitution (đánh dấu thay thế)
{>>Critic comment (comment)
{==Critic highlight + comment

🔢 Lists & Definitions

KeywordChức năng
taskTask list (checkbox list)
defDefinition list
fnFootnote (chú thích cuối trang)

🔣 Icons & Emojis

KeywordChức năng
:Emoji shortcode
:materialMaterial Design icons
:simpleSimple Icons
:faFontAwesome icons
:octiconsGitHub Octicons

🧮 Math

KeywordChức năng
$$Math block (công thức toán học khối)
$Inline math (công thức inline)

🎯 Special Elements

KeywordChức năng
progressProgress bar
abbrAbbreviation (viết tắt)
annoText annotation
detailsHTML details/summary element
centerCenter aligned text
youtubeEmbed YouTube video

💡 Mẹo Sử Dụng

Tự động hoàn thiện

  • Gõ keyword và nhấn Tab hoặc Enter để trigger snippet
  • Dùng Tab để di chuyển giữa các placeholder ($1, $2, …)
  • Dùng Shift+Tab để quay lại placeholder trước

Biến tự động

  • ${CURRENT_YEAR} - Năm hiện tại
  • ${CURRENT_MONTH} - Tháng hiện tại (2 chữ số)
  • ${CURRENT_DATE} - Ngày hiện tại (2 chữ số)
  • Một số snippet có dropdown để chọn (dùng mũi tên ↑↓)
  • Ví dụ: ??? cho phép chọn loại admonition
  • {1|option1,option2|} - syntax để tạo dropdown

Tổng số snippets: 80+

Demo

Demo