dev/docs/markdown_showcase.md

Markdown Showcase

A quick tour of many common Markdown elements so you can verify rendering.

---

Headings

H1

H2

H3

H4

H5

H6

---

Emphasis & Inline

• Plain: text
• Italic: text or text
• Bold: text or text
• Bold + Italic: text
• Strikethrough: text
• Code: let answer = 42;
• Escaping: *literal asterisks*, _underscores_, `backticks`

---

Blockquotes

Note: This is a single-level quote.

• It can include lists
• And inline code

Nested quote level two.

• Deep thought here

---

Lists

• Unordered list item
  • Nested item
    • Third level
• Another item

1. Ordered list item
   1. Nested item
   2. Another nested item
2. Second item

• Mixed list
  1. Ordered inside unordered
  2. Still works

---

Task Lists

• Render checkboxes
• Support unchecked state
• Handle nested tasks
  • Child complete
  • Child pending

---

Links

• Inline: OpenAI
• Title: Rust
• Reference: Codex CLI and CommonMark

---

Images

Caption: Placeholder banner to test image rendering.

---

Code Blocks

// Rust example
fn greet(name: &str) -> String {
    format!("Hello, {}!", name)
}

fn main() {
    println!("{}", greet("Codex"));
}

# Shell example
set -euo pipefail
./build-fast.sh
echo "Build finished."

{
  "name": "codex-demo",
  "version": "1.0.0",
  "private": true
}

# Cargo-like TOML
[package]
name = "codex-demo"
version = "0.1.0"
edition = "2021"

diff --git a/hello.txt b/hello.txt
--- a/hello.txt
+++ b/hello.txt
@@
-Hello Wordl
+Hello World

---

Simple Tables

First Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

Command	Description
git status	List all new or modified files
git diff	Show file differences that haven't been staged

Complex Table

Name	Type	Stars	Notes
codex-core	library	4,512	Core execution logic
codex-tui	app	1,203	Terminal UI
codex-web	app	987	Browser front-end

Alignment: left, center, right verified above.

Command	Description
git status	List all new or modified files
git diff	Show file differences that haven't been staged

Contains markdown

---

Footnotes

Here’s a sentence with a footnote marker.¹ And another one right here.²

---

Horizontal Rules

---

---

---

---

Collapsible

Click to expand

• This content is hidden by default.
• It can include lists and code:

Hidden block content.

---

Definition List

Term

The thing being defined.

Another Term

A second definition with more words for testing.

---

Callouts (Quote-style)

Note

This is a helpful note for readers.

Tip

Use format!("{value}") to inline variables.

Warning

Treat all warnings as failures during builds.

Important

Never modify sandbox env var handling in code.

---

Mermaid (Diagrams)

flowchart TD
    A[Start] --> B{Build?}
    B -- yes --> C[Run ./build-fast.sh]
    B -- no --> D[Edit code]
    C --> E[Success]
    D --> B

---

Mixed Content

• Emoji: ✅ 🚀 💡
• Math (literal text): E = mc^2
• Monospace paths: /usr/local/bin, src/main.rs
• HTML inline: ^sup and _sub

---

If you want more of any specific element (e.g., longer tables, nested lists, or additional code languages), tell me what to stress-test next.

---

1. This is the first footnote with more detail. ↩︎

2. A second footnote to test multiple references. ↩︎