Skip to main content

SEO Markdown formatting standard

Use this standard when creating, rewriting, or reviewing Markdown files in this SEO content tree.


Core rules

  • Use one # title per page.
  • Use sentence case for headings.
  • Keep heading hierarchy strict: # for page title, ## for main sections, ### for subtopics.
  • Remove raw metadata such as Author, Source, Created time, Urgency, and Tested unless it is converted into useful editorial context.
  • Remove chat transcript markers such as You said: and ChatGPT said:.
  • Avoid emoji headings in final learning materials.
  • Use --- only for meaningful section breaks.
  • Prefer short paragraphs, tables, checklists, and examples over long unstructured prose.
  • Use Docusaurus admonitions for teaching emphasis: :::tip, :::info, :::note, and :::warning.
  • Use Docusaurus tabs only when comparing before/after states or alternate approaches.

Curriculum lesson template

Use this for files under 01-curriculum/, except index pages.

# Topic title

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

## Foundational Concepts

### What is [topic]?

Define the topic in plain language, explain why it matters, and include a relatable analogy.

<Tabs>
<TabItem value="before" label="Before" default>
```text
Weak or incomplete example.
```
</TabItem>
<TabItem value="after" label="After">
```text
Improved example.
```
</TabItem>
</Tabs>

:::tip
State the core principle learners should remember.
:::

---

→ Continue to [Practical Strategies](#practical-strategies)

## Practical Strategies

### Strategy topic

Explain workflows, decisions, and implementation patterns.

---

→ Continue to [Technical Implementation](#technical-implementation)

## Technical Implementation

### Implementation topic

Show tools, platform steps, validation checks, and operational details.

---

→ Continue to [Results Measurement](#results-measurement)

## Results Measurement

### Metrics topic

Explain how to measure progress, diagnose issues, and report outcomes.

---

→ Continue to [Emerging Trends](#emerging-trends)

## Emerging Trends

### Trend topic

Cover current SEO changes and future-facing considerations.

---

→ Continue to [Resources](#resources)

## Resources

### Recommended tools

List useful tools, references, checklists, and next learning steps.

Knowledge base article template

Use this for files under 02-knowledge-base/.

# Topic title

---

## Overview

Explain the concept clearly in 2-4 paragraphs.

## Why It Matters

Connect the concept to SEO performance, user experience, content quality, or business outcomes.

## Core Concepts

### Subtopic

Explain the main components with examples, tables, or diagrams.

## Practical Application

Give steps, workflows, or checklists.

## Examples

Show realistic examples or before/after comparisons.

## Common Mistakes

List mistakes and explain how to avoid them.

## Related Concepts

Link to related curriculum or knowledge-base pages.

Completion checklist

  • One clear page title.
  • No raw metadata or chat transcript residue.
  • Strict heading hierarchy.
  • Clear overview or introduction.
  • Practical examples included.
  • Tables, checklists, tabs, diagrams, or admonitions used where they improve learning.
  • Related links added where useful.
  • Markdown renders cleanly in Docusaurus.