wittle/docs

Markdown Guide

A quick guide to the Markdown you can use in Wittle.

This page is a practical “what works” guide for writing pages in Wittle.

Text

  • Bold
  • Italic
  • Bold italic
  • Inline code: PageRendering::Renderer

Headings

H2

H3

Lists

  1. Ordered item
  2. Another item
    • Nested bullet
    • Another nested bullet

Quotes

Wittle pages are just Markdown.

Code blocks

def hello(name)
  "Hello, #{name}"
end

Links

YAML front matter (optional)

Wittle’s import/export format supports YAML front matter like:

name: My Page
summary: A short description
icon: "⭐️"

In the docs and demo wikis, the front matter is used for things like page icons and summaries.