Formatting

How to format? #

Hugo uses Markdown to format text. Find out more on how to format Markdown files. The raw markdown file of this page can be seen here.

The hugo book theme enables the use of Mermaid diagrams …

stateDiagram-v2 idea --> prototype: 🛠

… and KaTeX math typesetting.

\(e^{\pi i} + 1 = 0\)
print("Format code in your Markdown file.")

Try to always add a descriptive caption to an included image. Also make sure images are not unnecessarily large.

Two care bears putting on their seat belts.

Two care bears putting on their seat belts.

You can also embed videos. For more details see the hugo-video theme component.

More details on how to use the Hugo book theme can be found here.

You can also create:

  • unordered lists
  • and tables:
MilestoneDate
Idea1.1.1979
New idea2.1.1979
Prototype3.1.1979

Also task lists can be formatted:

  • Prototype
  • Documentation