The Complete Markdown Guide: Commands, Examples, and Best Practices

Markdown is the lingua franca of technical documentation. Whether you're writing code documentation, README files, or taking notes in Notexs, mastering Markdown syntax will dramatically boost your productivity.

This guide covers everything from basics to advanced features, with examples you can copy and use immediately.

Why Markdown?

Before diving into syntax, let's understand why Markdown has become the standard for technical writing:

• Simple: Easy to read and write, even in plain text
• Portable: Works everywhere—GitHub, Notion, Notexs, forums, and more
• Fast: No mouse needed, just keyboard shortcuts
• Version-control friendly: Plain text files work perfectly with Git
• Future-proof: Will be readable decades from now

Basic Syntax

Headings

Headings structure your document and create hierarchy. Use # symbols:

# H1 - Main Title
## H2 - Major Section
### H3 - Subsection
#### H4 - Sub-subsection

Best Practice: Use only one H1 per document. Use H2 for major sections, H3 for subsections.

Text Formatting

Make text stand out with these simple formatting options:

**Bold text** or __Bold text__
*Italic text* or _Italic text_
***Bold and italic***
~~Strikethrough text~~
`Inline code`

Result:

• Bold text
• Italic text
• Bold and italic
• Strikethrough text
• Inline code

Lists

Unordered Lists

Use -, *, or + for bullet points:

- First item
- Second item
  - Nested item
  - Another nested item
- Third item

Ordered Lists

Use numbers followed by a period:

1. First step
2. Second step
   1. Sub-step A
   2. Sub-step B
3. Third step

Task Lists

Perfect for to-do lists and project tracking:

- [x] Completed task
- [ ] Pending task
- [ ] Another pending task

Links

Create clickable links with this syntax:

[Link text](https://example.com)
[Link with title](https://example.com "Hover text")

Example: Visit Notexs

Images

Embed images using a similar syntax to links, but with a ! prefix:

![Alt text](image-url.jpg)
![Alt text with title](image-url.jpg "Image title")

Blockquotes

Highlight quotes or important notes:

> This is a blockquote.
> It can span multiple lines.
>
> You can also have multiple paragraphs.

Result:

This is a blockquote. It can span multiple lines.

Horizontal Rules

Create visual separators:

---
***
___

All three create the same result: a horizontal line.

Intermediate Syntax

Code Blocks

One of Markdown's superpowers for developers:

Inline Code

Wrap text in backticks for inline code:

Use the `console.log()` function for debugging.

Code Blocks with Syntax Highlighting

Use triple backticks with the language name for beautiful syntax highlighting:

function greet(name) {
  console.log(`Hello, ${name}!`);
}

greet("Notexs");

Supported languages: JavaScript, TypeScript, Python, Java, C++, Go, Rust, PHP, Ruby, Swift, Kotlin, HTML, CSS, SQL, and 100+ more!

Tables

Create structured data displays:

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1    | Data     | Data     |
| Row 2    | Data     | Data     |

Alignment:

| Left aligned | Center aligned | Right aligned |
|:-------------|:--------------:|--------------:|
| Left         | Center         | Right         |

Footnotes

Add references and citations:

Here's a sentence with a footnote.[^1]

[^1]: This is the footnote content.

Advanced Features

Mathematical Formulas (LaTeX)

Notexs supports KaTeX for beautiful mathematical notation:

Inline Math

The formula $E = mc^2$ is Einstein's mass-energy equivalence.

Block Math

$$
\int_{a}^{b} f(x) \, dx = F(b) - F(a)
$$

Common Math Examples:

$\frac{n!}{k!(n-k)!}$           # Binomial coefficient
$\sum_{i=1}^{n} x_i$            # Summation
$\sqrt{x^2 + y^2}$              # Square root
$\alpha, \beta, \gamma$         # Greek letters

Mermaid Diagrams

Create flowcharts, sequence diagrams, and more with code:

Flowchart

Sequence Diagram

Gantt Chart

Charts and Data Visualization

Notexs supports Chart.js integration for interactive charts (example format):

type: bar
labels: [Jan, Feb, Mar, Apr, May]
data: [12, 19, 3, 5, 2]

Power User Tips

Keyboard Shortcuts in Notexs

• Cmd/Ctrl + B: Bold
• Cmd/Ctrl + I: Italic
• Cmd/Ctrl + K: Insert link
• Cmd/Ctrl + Shift + C: Code block
• Cmd/Ctrl + E: Toggle preview

Document Organization

Use a consistent structure:

# Document Title

Brief introduction paragraph.

## Table of Contents

## Section 1: Getting Started

### Subsection 1.1

### Subsection 1.2

## Section 2: Deep Dive

...

Markdown Cheatsheet Template

Save this template in Notexs for quick reference:

Text Formatting: **bold** *italic* ~~strike~~

Links: [text](url)

Images: ![alt](url)

Lists: Use - or 1. for items, - [ ] for tasks

Code: Inline with backticks, blocks with triple backticks + language

Tables: Use | to separate columns, --- for headers

Math: Use $ for inline, $$ for block equations

Diagrams: Use Mermaid syntax in code blocks

Common Mistakes to Avoid

1. Missing blank lines: Always add blank lines before/after code blocks, lists, and headings
2. Inconsistent list markers: Stick to - or *, don't mix them
3. Forgetting code block languages: Always specify for proper syntax highlighting
4. Too many heading levels: Rarely go beyond H4
5. Not using preview: Always preview your Markdown before publishing

Markdown in Notexs: Special Features

Notexs extends standard Markdown with:

• Real-time preview: See formatted text as you type
• Auto-complete: Smart suggestions for Markdown syntax
• Snippet library: Save commonly used patterns
• Export options: PDF, HTML, or raw Markdown
• Version history: Never lose your work
• Collaborative editing: Share and edit together

Practice Exercises

Try creating these in Notexs:

1. Personal README: Introduce yourself with headings, lists, and links
2. Meeting Notes Template: With date, attendees, agenda, and action items
3. Code Documentation: Function descriptions with code examples
4. Weekly Report: Using tables for metrics and progress
5. Project Plan: With Gantt chart and task lists

Resources

• CommonMark Spec - The standard Markdown specification
• GitHub Flavored Markdown - GitHub's extensions
• KaTeX Documentation - Math syntax reference
• Mermaid Documentation - Diagram syntax guide

Next Steps

Now that you understand Markdown syntax, you're ready to:

1. Create your first note in Notexs
2. Organize your knowledge into notebooks
3. Use tags and metadata for better organization
4. Share your documentation with your team
5. Export and publish your work

Remember: The best way to learn Markdown is to use it daily. Start with simple formatting, then gradually incorporate advanced features like math and diagrams.

Happy writing! 🚀