Writing & Markdown

Markdown Cheat Sheet

Quick reference cheat sheet for Hugo markdown syntax — formatting, callouts, code blocks, math, diagrams, and shortcodes with examples.

Ownable uses GitHub Flavored Markdown (GFM) with powerful extensions for callouts, math, diagrams, and shortcodes. This page is a quick-reference cheat-sheet — click any topic for full documentation.

Quick Reference

SyntaxDescriptionGuide
**Bold**, *Italic*Text formattingText Formatting
[Link](url)Internal & external linksLinks
- Item, 1. ItemOrdered, unordered, task listsLists & Task Lists
![Alt](image.jpg)Images, figures, captionsImages & Figures
| Col | Col |Markdown tablesTables
> [!NOTE]Callouts / asidesCallouts
```langSyntax-highlighted codeCode Blocks
$E=mc^2$LaTeX math with KaTeXMath (KaTeX)
```mermaidFlowcharts, sequence diagramsDiagrams (Mermaid)

Shortcodes

Shortcodes are special Hugo templates that insert rich components into your content.

ShortcodeDescription
buttonCTA buttons with styles, sizes, and icons
iconInline SVG icons
cardsCard grid layouts
stepsNumbered step sequences
spoilerCollapsible/toggle content
embedGitHub, HuggingFace, and URL embeds
video / audioMedia players
notebookJupyter notebook rendering
chartPlotly interactive charts
tableCSV table import
cite / mentionAcademic citations & author mentions
toc / includeTable of contents & file includes

Best Practices

  • Relative Links — Use [Link](../page) instead of full URLs for portability
  • Asset Location — Keep images in assets/media/ for global use, or in the page bundle for page-specific use
  • Accessibility — Always add alt text to images: ![Alt text](image.jpg)
  • Prefer Markdown — Use standard Markdown (callouts, code blocks, tables) over shortcodes when possible for better portability

For front matter configuration (title, date, tags, images, etc.), see the Front Matter Reference. For page-level feature toggles (TOC, sharing, comments), see Page Features.

Was this page helpful?

From the makers of

© 2026 Lore Labs.

On this page