Markdown Cheatsheet and VSCode Tools

Markdown Cheatsheet and VSCode Tools

Quick reference for Markdown syntax and VSCode extensions to enhance your writing workflow.

Markdown Cheatsheet and VSCode Tools

Markdown is a lightweight, readable markup language for writing documentation, blogs, and notes. This guide provides quick syntax reference and VSCode tools to enhance your workflow.

📝 Markdown Syntax

Headings

# H1

## H2

### H3

#### H4

##### H5

###### H6

Emphasis

_italic_ or _italic_
**bold** or **bold**
~~strikethrough~~

Lists

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Next item
[Link text](https://example.com)
![Alt text](image.jpg)

Code

Inline `code` in text

```javascript
// Code block with syntax highlighting
console.log('Hello');
```

Blockquotes

> This is a quote.
> Continues here.

Tables

| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |

Horizontal Rule

---

🛠️ VSCode Extensions for Markdown

Markdown All in One

Keyboard shortcuts, table generation, and automatic list formatting. Essential for fast Markdown writing.

Markdown Preview Enhanced

Real-time preview with support for Mermaid diagrams, LaTeX math, and export to PDF/HTML.

Paste Image

Paste screenshots directly into your Markdown file. Images are auto-saved and linked.

Markdownlint

Lints your Markdown for consistency and best practices. Helps enforce style guidelines.

Docsify or Docusaurus Snippets

Pre-written snippets for popular static site generators. Speeds up documentation authoring.

📱 Tools for Markdown Writing

ToolTypeBest For
TyporaWYSIWYG EditorDistraction-free writing
ObsidianKnowledge BasePersonal wikis and notes
DillingerOnline EditorQuick editing in browser
PandocConverterConverting to PDF, DOCX, etc.

💡 Writing Tips

  1. Use clear headings: Structure your document with proper heading hierarchy
  2. Keep lines under 80 characters: Makes diffs readable in version control
  3. Use lists for scanability: Readers skim; lists help them find info fast
  4. Link liberally: Connect related content for better navigation
  5. Test your links: Broken links break trust; verify before publishing

📚 Resources