Document Title (H1)

Main Section (H2)

Subsection (H3)

Sub-subsection (H4)

Another Main Section (H2)

Subsection (H3)

Don't do this:

Title 1

Title 3 (skipped H2)

Document Title

This is the document introduction.

Chapter 1

This is the content of chapter 1.

1.1 Subsection

This is subsection content.

• List item 1
• List item 2

Code example:

console.log("Hello World");

Chapter 2

This is chapter 2 content.

In this article, we'll discuss Markdown usage
and how to apply it on GitHub.

We'll also mention Stack Overflow best practices.

Benefits:

1. Centralized link management
2. Cleaner reading experience
3. Easier maintenance

Project Documentation

• Quick Start
• API Documentation
• FAQ

Image references:

Advantages of relative paths:

• Easy document migration
• Offline browsing support
• Reduced maintenance cost

Good practice:

function calculateSum(a, b) {
  return a + b;
}

def calculate_sum(a, b):
  return a + b

Avoid this:

function calculateSum(a, b) {
  return a + b;
}

// User authentication middleware
function authenticateUser(req, res, next) {
  // Get token from request headers
  const token = req.headers.authorization;
  
  if (!token) {
      // Return 401 error if no token
      return res.status(401).json({ error: 'No token provided' });
  }
  
  try {
      // Verify token validity
      const decoded = jwt.verify(token, process.env.JWT_SECRET);
      req.user = decoded;
      next();
  } catch (error) {
      // Handle invalid token
      return res.status(403).json({ error: 'Invalid token' });
  }
}

Recommended format:

Also acceptable (same functionality):

Good practice:
This is a paragraph of appropriate length. It's not too long to be
difficult to read, nor too short to appear fragmented.

Avoid:
This is an extremely extremely extremely extremely extremely extremely extremely extremely extremely extremely extremely extremely extremely extremely extremely long paragraph that will make readers tired and difficult to track reading position.

Also avoid:
Too short.
Paragraphs.
Hard to read.

Project Features

Our project has the following features:

• High Performance: Optimized algorithms and data structures
• Ease of Use: Intuitive API design
• Extensible: Plugin-based architecture
• Cross-platform: Support for multiple operating systems

Installation Requirements

Before starting, ensure your system meets these requirements:

1. Node.js version >= 14.0.0
2. npm version >= 6.0.0
3. OS: Windows 10+, macOS 10.15+, Ubuntu 18.04+
4. Memory: At least 4GB RAM

Good practice:
This is the first sentence.
This is the second sentence.
This is the third sentence.

Avoid:
This is the first sentence. This is the second sentence. This is the third sentence.

Advantages:

• Clearer Git diffs
• Easier to track changes
• Reduced merge conflicts

docs/
├── en/
│ ├── README.md
│ ├── getting-started.md
│ └── api.md
├── zh/
│ ├── README.md
│ ├── getting-started.md
│ └── api.md
└── README.md # Main doc linking to language versions

Add language switcher to each document:

• English
• 中文

Image Usage Guidelines

Local Images

Online Images (ensure stability)

Compress Large Images

For large images, consider:

• Use appropriate resolution
• Choose suitable format (WebP, PNG, JPEG)
• Provide multiple size versions

Add Alt Text

All images should have descriptive alt text,
which is important for accessibility and SEO.

Document Title - Clear for Text Conversion

Section with Text-Friendly Headers

Subsection: Easy to Read in Text Format

Use consistent formatting that converts cleanly:

• Bullet points maintain structure in md to text output
• Keep paragraph lengths moderate for readability
• Use clear, descriptive headings for text navigation

Bold emphasis works well in text conversion.
Italic text is preserved in markdown to text processing.

Code blocks provide context even in text format
Perfect for markdown to text documentation workflows

Blockquotes maintain meaning in text conversion
Useful for highlighting important information

Links like MD to Text Converter
remain accessible in text output.

Recommended Tools for Markdown to Text Workflows

Text Conversion Editors

• Typora: WYSIWYG editor with excellent text export
• Mark Text: Real-time preview with clean text output
• VS Code: Markdown extensions optimized for text conversion
• Obsidian: Note-taking with superior md to text capabilities

Markdown Converter Tools

• Pandoc: Universal document converter with text output
• Marked: Fast markdown to text processing
• Turndown: HTML to markdown conversion for text workflows
• Remark: Powerful markdown processor for text conversion

Text Processing Platforms

• GitBook: Documentation with clean text export
• VuePress: Static site generator with text conversion support
• Gatsby: React-based platform with markdown to text capabilities
• Docusaurus: Facebook's platform optimized for text output

Online Text Conversion Tools

• MD to Text Converter: Specialized markdown to text processing
• StackEdit: Online editor with text export features
• Dillinger: Cloud markdown editor with clean text output
• Markdown Live Preview: Real-time text conversion preview

Command-Line Text Processing

• Pandoc CLI: Command-line markdown to text conversion
• Marked CLI: Fast text processing from markdown
• Remark CLI: Advanced text conversion workflows
• Custom Scripts: Automated md to text batch processing