Guide
Writing your resume in Markdown
mdesume extends standard Markdown with a few special symbols (directives written on their own line) for controlling layout — multi-column lists, text alignment, and custom spacing. Each example below shows the same content without and with the symbol. New to Markdown? Getting Started is a great place to learn.
Standard Markdown you can use
Everything below works exactly as you'd expect — no special symbols required. See the full syntax at Markdown Guide: Basic Syntax .
| Element | Syntax | Notes |
|---|---|---|
| Heading | # H1 · ## H2 · ### H3 | H1 = name, H2 = section, H3 = role/subtitle. Docs |
| Bold / Italic | **bold** · _italic_ | Use italic for titles/roles. Docs |
| Link | [label](url) | GitHub / LinkedIn / LeetCode get icons automatically. Docs |
| Bullet list | - item | Set global columns in the Customizer. Docs |
| Table | | a | b | |---|---| | GitHub-Flavored Markdown tables. Docs |
mdesume Advanced Symbols
mdesume provides several advanced symbols and syntax extensions to enhance your resume writing experience.
Columns
::col-2:: … ::end-col::Wrap content in
::col-N:: and ::end-col:: to lay it out in N columns (2, 3, or 4). Perfect for skills, languages, or compact project grids. A heading of depth 1–2 automatically ends the column block.Without
Skills
- Languages: JavaScript, TypeScript, Python
- Backend: Node.js, Express, REST APIs
- Frontend: React, Next.js, Angular
- Cloud: GitHub Actions, Docker, GCP
## Skills - **Languages**: JavaScript, TypeScript, Python - **Backend**: Node.js, Express, REST APIs - **Frontend**: React, Next.js, Angular - **Cloud**: GitHub Actions, Docker, GCP
With
Skills
Languages: JavaScript, TypeScript, Python
Backend: Node.js, Express, REST APIs
Frontend: React, Next.js, Angular
Cloud: GitHub Actions, Docker, GCP
## Skills ::col-2:: - **Languages**: JavaScript, TypeScript, Python - **Backend**: Node.js, Express, REST APIs - **Frontend**: React, Next.js, Angular - **Cloud**: GitHub Actions, Docker, GCP ::end-col::
Text Alignment
::align-center:: … ::end-align::Align a block of content with
::align-left::, ::align-center::, ::align-right::, or ::align-justify::, closed by ::end-align::. Great for centering a name and contact line in the header.Without
Jane Doe
Software Engineer
jane@email.com · linkedin.com/in/jane
# Jane Doe Software Engineer [jane@email.com](mailto:jane@email.com) · linkedin.com/in/jane
With
Jane Doe
Software Engineer
jane@email.com · linkedin.com/in/jane
::align-center:: # Jane Doe Software Engineer [jane@email.com](mailto:jane@email.com) · linkedin.com/in/jane ::end-align::
Vertical Spacing
::height-24::Insert a blank vertical spacer of N pixels with
::height-N::(no closing tag). Use it to fine-tune gaps between sections when automatic spacing isn't quite right.Without
Experience
Senior Developer | Acme Corp
Education
BCA, University of Example
## Experience **Senior Developer** | Acme Corp ## Education BCA, University of Example
With
Experience
Senior Developer | Acme Corp
Education
BCA, University of Example
## Experience **Senior Developer** | Acme Corp ::height-32:: ## Education BCA, University of Example
Skill Badges
::badges:: … ::end-badges::Wrap a comma- or line-separated list in
::badges:: and ::end-badges:: to render each item as a rounded pill — cleaner than a plain bullet list for skills.Without
Skills: JavaScript, TypeScript, React, Node.js
**Skills:** JavaScript, TypeScript, React, Node.js
With
JavaScriptTypeScriptReactNode.js
::badges:: JavaScript, TypeScript, React, Node.js ::end-badges::
Proficiency Rating
::rating-N::Add a 5-bar proficiency indicator with
::rating-N:: (N is 0–5). Great for languages or soft skills.Without
Leadership: 4 / 5
Leadership: 4 / 5
With
Leadership
Leadership ::rating-4::
Flex Row
::row:: … ::end-row::Lay children out on a single spaced row with
::row:: / ::end-row:: — perfect for a title on the left and a date on the right.Without
Senior Developer | Acme Corp
2020 – 2024
**Senior Developer** | Acme Corp _2020 – 2024_
With
Senior Developer | Acme Corp2020 – 2024
::row:: **Senior Developer** | Acme Corp _2020 – 2024_ ::end-row::
Callout Note
::note:: … ::end-note::Wrap text in
::note:: / ::end-note:: to render a highlighted callout box — useful for a summary highlight.Without
Recognized as top 3% problem solver.
Recognized as top 3% problem solver.
With
Recognized as top 3% problem solver.
::note:: Recognized as top 3% problem solver. ::end-note::
Compact Spacing
::compact:: … ::end-compact::Wrap a block in
::compact:: / ::end-compact:: to tighten the vertical spacing of its children for dense sections.Without
- Shipped 3 features
- Improved perf 40%
- Led 2 releases
- Shipped 3 features - Improved perf 40% - Led 2 releases
With
- Shipped 3 features
- Improved perf 40%
- Led 2 releases
::compact:: - Shipped 3 features - Improved perf 40% - Led 2 releases ::end-compact::
Profile Photo
::avatar[url]::Drop a circular profile photo into the header with
::avatar[url]:: (no closing tag). Use an absolute image URL.Without
Jane Doe
Software Engineer
# Jane Doe Software Engineer
With
Jane Doe
Software Engineer
::avatar[https://i.pravatar.cc/160]:: # Jane Doe Software Engineer
QR Code Box
::qr[url]::Add a QR placeholder box linking to a URL with
::qr[url]:: (no closing tag). Shown as a dashed box with the link — handy for a portfolio QR.Link Without Icon
::no-icon::[Link](url)Prefix or wrap any link with
::no-icon:: in a heading, paragraph, or list item to suppress the automated platform icon (Globe, GitHub, LinkedIn, etc.). Perfect for clean project titles or plain link text.Without
WhatsApp SDK: Business API Integration Framework
### [WhatsApp SDK: Business API Integration Framework](https://pub.dev/packages/whatsapp)
With
WhatsApp SDK: Business API Integration Framework
### ::no-icon::[WhatsApp SDK: Business API Integration Framework](https://pub.dev/packages/whatsapp)