GitHub Flavored Markdown (GFM) Example #

Generated by ChatGPT (I can't be bothered to write all this out)

Headings #

H1 #

H2 #

H3 #

H4 #

H5 #

H6 #

Paragraphs #

This is a normal paragraph.

This is another paragraph separated by a blank line.

Line breaks can be forced by ending a line with two spaces. Like this.

Text Formatting #

Italic

Italic

Bold

Bold

Bold Italic

Bold Italic

Strikethrough

Bold with nested italic.

Inline code inside a sentence.

Blockquotes #

This is a blockquote.

It can span multiple paragraphs.

Nested blockquote.

Triple nested blockquote.

Lists #

Unordered #

• Apple
• Banana
• Orange
  • Mandarin
  • Clementine
    • Nested

• Another list

• Another style

Ordered #

1. First
2. Second
3. Third
   1. Nested
   2. Nested

Mixed #

1. Item
   • Bullet
   • Bullet
2. Item

Task Lists #

• Completed
• Another completed task
• Incomplete
• Another incomplete

Links #

Inline:

GitHub

Reference:

GitHub Docs

Automatic:

https://tangled.org

Email:

someone@example.com

Images #

Image with title:

Code #

Inline:

print("Hello")

Indented code:

def hello():
    print("Hello")

Fenced:

Plain text

Language highlighting:

def greet(name):
    print(f"Hello {name}")

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

interface User {
  name: string;
}

{
  "name": "example",
  "version": 1
}

services:
  app:
    image: nginx

echo "Hello"

+ Added line
- Removed line

graph TD
    A --> B
    B --> C

Horizontal Rules #

Tables #

Footnotes #

Here is a sentence with a footnote.^[1]

Another footnote.^[2]

Escaping Characters #

*Not italic*

# Not a heading

`Not code`

\ Backslash

HTML #

Ctrl + C

_Subscript

^Superscript

Details #

Hidden code block

Emoji #

Unicode:

😀 🚀 ❤️

GitHub shortcode:

😄

🚀

🎉

⚠️

✅

Mentions #

@csw.im

#123

tangled.org/core#456

Commit:

ec170ad5a21e38036663a7e6482c0aa4cda40ed5

References #

Issue:

Fixes #12

Closes #15

Related to #20

Alerts #

Math #

Inline math:

$E = mc^2$

Display math:

$$ \int_0^\infty e^{-x},dx = 1 $$

Autolinks #

https://tangled.org

tangled.org

mailto:someone@example.com

Definition-style HTML #

Markdown

A lightweight markup language.

GFM

GitHub Flavored Markdown.

Mixed Formatting Example #

Quote Heading #

• Bold
• Italic
• Code
• Link

print("Inside quote")

Nested Everything #

1. First
   • Bullet

     Quote

     echo "nested"
     

     • Task
     • Task

HTML Comments #

Mermaid Diagram #

flowchart TD
    %% User
    U([User]) --> A[Open Web Application]

    %% Authentication
    subgraph AUTH["Authentication Service"]
        A --> B{Authenticated?}
        B -- No --> C[Login Page]
        C --> D[Validate Credentials]
        D --> E{Valid?}
        E -- No --> C
        E -- Yes --> F[Issue JWT Token]
        F --> G[Dashboard]
        B -- Yes --> G
    end

    %% Frontend
    subgraph FRONTEND["Frontend"]
        G --> H[Load User Profile]
        G --> I[Load Projects]
        G --> J[Load Notifications]
    end

    %% API Gateway
    subgraph API["API Gateway"]
        H --> K
        I --> K
        J --> K
        K[Route Request]
    end

    %% Backend Services
    subgraph SERVICES["Microservices"]
        K --> L[User Service]
        K --> M[Project Service]
        K --> N[Notification Service]
        K --> O[Analytics Service]
    end

    %% Database Layer
    subgraph DATA["Persistence Layer"]
        L --> P[(Users DB)]
        M --> Q[(Projects DB)]
        N --> R[(Notifications DB)]
        O --> S[(Analytics DB)]
    end

    %% Cache
    subgraph CACHE["Caching"]
        T[(Redis Cache)]
    end

    L <--> T
    M <--> T
    N <--> T

    %% Event Bus
    subgraph EVENTS["Event Bus"]
        V((Kafka))
    end

    M --> V
    L --> V
    N --> V

    %% Background Workers
    subgraph WORKERS["Async Workers"]
        W[Email Worker]
        X[Search Indexer]
        Y[Metrics Aggregator]
    end

    V --> W
    V --> X
    V --> Y

    %% External Systems
    subgraph EXTERNAL["External Services"]
        Z1[Email Provider]
        Z2[Search Engine]
        Z3[Monitoring]
    end

    W --> Z1
    X --> Z2
    Y --> Z3

    %% Error Handling
    K --> ERR{Service Error?}
    ERR -- Yes --> LOG[Log Error]
    LOG --> RETRY{Retry?}
    RETRY -- Yes --> K
    RETRY -- No --> FAIL([Return Error])
    ERR -- No --> OK([Return Success])

    %% Styling
    classDef db fill:#f9f,stroke:#333,stroke-width:2px;
    classDef service fill:#bbf,stroke:#333,stroke-width:1px;
    classDef worker fill:#bfb,stroke:#333,stroke-width:1px;
    classDef decision fill:#ffd966,stroke:#333,stroke-width:2px;

    class P,Q,R,S,T db;
    class L,M,N,O service;
    class W,X,Y worker;
    class B,E,ERR,RETRY decision;