Demo

3 minute read Published: 2025-08-13

This is a demonstration of Markdown capabilities in Zola.

Table of Contents

📚 Markdown Feature Showcase

Goal: A single file demonstrating the most commonly supported Markdown features on GitHub (GFM).
Use this file to test renderers or as a quick reference.1



Headings

H1

H2

H3

H4

H5
H6

Paragraphs & Line Breaks

A normal paragraph flows as expected.
A hard line break uses two spaces at the end of the line.
This line starts a new line without a blank paragraph.

This is a new paragraph (separated by a blank line).


Emphasis

  • Italic using single asterisks or underscores.
  • Bold using double asterisks or underscores.
  • Bold+Italic with triple markers.
  • Inline code can mix with bold and italic.

Inline Code & Escapes

Use backticks for inline code like `ls -la` or to show backticks themselves: `code with a backtick \` inside`

Escaping characters: *not bold*, _not italic_, ~not tilde~.


Blockquotes

A single-level quote.

  • Can include lists
  • And emphasis

Nested quote level 2
Even bold here.


Lists

Unordered

  • Item A
    • Nested A.1
      • Nested A.1.a
  • Item B

Ordered

  1. Step one
  2. Step two
    1. Sub-step two.a
    2. Sub-step two.b
  3. Step three

Task Lists (GFM)

  • Implement feature
  • Write tests
    • Unit tests
    • Integration tests
  • Ship 🚀

Inline link: GitHub.
Reference link: CommonMark.
Autolink: https://commonmark.org

You can also link to a section like Task Lists.


Images

Inline image:

Octocat waving

Reference image:

Markdown Logo


Tables (GFM)

FeatureSupportedNotes
AlignmentUse :--- left, :---: center, ---: right
Task listsGFM only
FootnotesGFM only
HTML passthrough⚠️Limited; depends on renderer

Code Blocks

Fenced code blocks support an info string for syntax highlighting.

Python

# A tiny Python example with docstring and typing
# Docs: https://docs.python.org/3/library/typing.html
from __future__ import annotations
from typing import Iterable, List

def squares(nums: Iterable[int]) -> List[int]:
  """
  Return a list of squared numbers.
  """
  return [n * n for n in nums]

if __name__ == "__main__":
  data = [1, 2, 3, 4]
  print("Input:", data)
  print("Squares:", squares(data))

Kotlin

// Simple Kotlin example (no external libraries required)
// Kotlin docs: https://kotlinlang.org/docs/basic-syntax.html
fun greet(name: String): String {
  // Returns a greeting message
  return "Hello, $name!"
}

fun main() {
  val names = listOf("Ada", "Alan", "Akito")
  // Print greetings
  names.forEach { println(greet(it)) }
}

Bash

# Bash snippet with immutable variables (readonly)
# (Note: This is a demonstration snippet, not a script header)
declare -r GREETING="hello"
declare -r TARGET="world"
printf '%s, %s!\n' "$GREETING" "$TARGET"

Tip: Use ``` fences. If you need to show triple backticks inside a code block, fence with four backticks:

```python
print("This is shown literally.")
```

Footnotes (GFM)

You can cite a footnote like this.2 You can reuse it2 and also have multiple footnotes.3


Collapsible Sections

Click to expand: Release Notes (example)
  • Added: Footnotes support
  • Fixed: Table rendering on mobile
  • Deprecated: Legacy callouts

Strikethrough & Emoji (GFM)

  • Deprecated feature (no longer in use)
  • Emojis: 🎉 🚀 ☕

Math (GitHub)

Inline math: $E = mc^2$.

Block math:

\int_{-\infty}^{\infty} e^{-x^2} \, dx = \sqrt{\pi}

Mermaid Diagrams (GitHub)

flowchart TD
  A[Start] --> B{Is it Markdown?}
  B -- Yes --> C[Render nicely]
  B -- No  --> D[Convert or skip]
  C --> E[Done]
  D --> E[Done]

Inline HTML (Portable Snippets)

Press Ctrl + C to copy. Small print can be styled with HTML when allowed.

Note: Some renderers sanitize or disallow certain HTML tags.


Reference-Style Definitions


1

Scope: This file targets CommonMark + GFM as rendered on GitHub. Some features (math, Mermaid, footnotes, task lists) are GitHub-specific.

2

Footnotes are great for adding side-notes without cluttering the main text.

3

Another footnote example referencing additional context or sources.