Markdown Guide

This guide demonstrates all supported Markdown features in PulseView documentation.

Headings

You can use headings from H1 to H6:

H1 Heading

H2 Heading

H3 Heading

H4 Heading

---

Text Formatting

You can make text bold, italic, or both.

You can also use strikethrough text.

---

Lists

Unordered Lists

• Item 1
• Item 2
  • Nested item 2.1
  • Nested item 2.2
• Item 3

Ordered Lists

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

Task Lists

• Completed task
• Incomplete task
• Another task

---

Links and Images

Visit PulseView

Documentation Home

---

Code

Inline Code

Use inline code for short code snippets.

Code Blocks

// JavaScript example
function greet(name) {
  return `Hello, ${name}!`;
}

console.log(greet('PulseView'));

# Python example
def greet(name):
    return f"Hello, {name}!"

print(greet("PulseView"))

# Bash example
npm install pulseview
npm run dev

---

Blockquotes

This is a blockquote. It can span multiple lines.

And even multiple paragraphs.

Note: Important information goes here.

---

Tables

Feature	Supported	Notes
Tables	✅	Full GFM support
Strikethrough	✅	Use ~~text~~
Task Lists	✅	Use - [ ] or - [x]
Autolinks	✅	URLs auto-convert
Code Blocks	✅	Syntax highlighting

Alignment

Left	Center	Right
Text	Text	Text
More	More	More

---

Horizontal Rules

You can create horizontal rules with ---:

---

Autolinks

URLs are automatically converted to links:

https://pulseview.com support@pulseview.com

---

Advanced Features

Nested Lists with Code

1. First step

   npm install
   

2. Second step

   • Configure your settings
   • Run the application

   npm run dev
   

3. Third step

   • Test everything
   • Deploy

Mixed Content

Here's a complex example combining multiple features:

Important: Before proceeding, make sure you have:

• Node.js installed
• npm configured
• Environment variables set

Then run:

npm install
npm run dev

---

Best Practices

1. Use headings hierarchically - Don't skip levels
2. Keep paragraphs short - Easier to read
3. Use code blocks - For all code examples
4. Add alt text - For all images
5. Test your links - Make sure they work

---

Summary

PulseView documentation supports:

• ✅ All standard Markdown syntax
• ✅ GitHub Flavored Markdown (GFM)
• ✅ Tables with alignment
• ✅ Task lists
• ✅ Strikethrough
• ✅ Autolinks
• ✅ Syntax highlighting
• ✅ Nested lists
• ✅ Blockquotes
• ✅ And much more!

Happy documenting! 🚀