jotacode

Junior Ribeiro

Back
Markdown cheatsheets

Markdown cheatsheets

Published onJanuary 31, 2025
Junior RibeiroJunior
0Views
3Minutes Read

Markdown Cheatsheet

Basic Syntax

Headers

H1 Header

H2 Header

H3 Header

H4 Header

H5 Header
H6 Header

Emphasis

Italic text or italic text Bold text or bold text Bold and italic or bold and italic Strikethrough

Lists

Unordered Lists

  • Item 1
  • Item 2
    • Subitem 2.1
    • Subitem 2.2
  • Item 3
  • Item 4

Ordered Lists

  1. First item
  2. Second item
    1. Subitem 2.1
    2. Subitem 2.2
  3. Third item

Links

Link text
Link with title

Images

Alt text
Click to enlarge

Vídeos e Embeds

YouTube:
Vimeo:
Twitter:
View Tweet

Blockquotes

This is a blockquote
Multiple paragraphs in blockquote
Nested blockquote

Code

Inline Code

Use code in your text

Code Blocks

main.js
1console.log('Hello!');
hello.rb
1puts "Hello!"

Emojis

this is a 😄 emoji others: 😄 😆 😊 😃

Diagrama Mermaid

Tables

Header 1Header 2Header 3
Cell 1Cell 2Cell 3
Cell 4Cell 5Cell 6

Horizontal Rules

Extended Syntax

Task Lists

  • Completed task
  • Incomplete task
  • (Optional) Optional task

Admonitions/Callouts

Callouts help highlight important information in your documentation. Each callout type has a specific purpose and visual style.

Basic Syntax

Available Callout Types

1. Note

Use for general information or helpful references. Example: "Remember to save your changes before exiting."

2. Tip

Use for helpful suggestions and best practices. Example: "You can use keyboard shortcuts to work faster."

3. Warning

Use for cautionary advice or potential issues. Example: "Backup your data before proceeding with the update."

4. Important

Use for crucial information that shouldn't be missed. Example: "API keys must never be shared publicly."

5. Caution

Use for risky operations or dangerous consequences. Example: "Deleting this folder will permanently remove all files."

6. Question

Use for FAQs or discussion points. Example: "Why should we use TypeScript over JavaScript?"

7. Quote

Use for citations or referenced material. Example: "Code is like humor. When you have to explain it, it's bad." - Cory House

8. Comment

Use for additional context or side notes. Example: "This feature is still in beta testing."

9. Docs

Use for documentation-specific information or references. Example: "Refer to the API documentation for more details."

Advanced Usage

Callouts support Markdown syntax inside them:

Example with Markdown

  • You can use bold text
  • Add italic emphasis
  • Include code snippets
  • Add lists and other Markdown elements
main.js
1console.log('Hello!');
user.ts
1interface User {
2  name: string;
3}
hello.rb
1puts "Hello!"
hello.rb
1puts "Hello!"

Footnotes

Here's a sentence with a footnote1.

Definition Lists

Term : Definition

Subscript and Superscript

H2O (subscript) X^2^ (superscript)

Keyboard Keys

Press <kbd>Ctrl</kbd> + <kbd>C</kbd> to copy

Mathematical Equations

Inline equation: E=mc2E = mc^2

Frontmatter (YAML)

yaml snippet
1---
2title: 'Markdown Guide'
3date: '2024-02-26'
4author: 'Your Name'
5tags:
6  - markdown
7  - guide
8  - reference
9---

Footnotes

  1. This is the footnote. ↩
Share:
Tags
#Markdown
#Cheatsheets
#Syntax
#Reference
Previous
Next