Markdown Syntax Guide

Markdown is a lightweight markup language designed to format text on the web quickly. This guide will walk you through the basics of Markdown, enabling you to create formatted text for you mdBook projects.

For a more comprehensive guide on Markdown visit here.

Getting Started

Markdown allows you to write using an easy-to-read, easy-to-write plain text format, which then converts to structured HTML. Below are the steps to start writing Markdown.

Text Formats

Text in Markdown can be easily formatted to improve the readability and high important sections.

• Bold: To make text bold, wrap it with two asterisks

This text will be bold

• Italic: Italicize text by wrapping text with a single asterisk

This text will be italicize

• Strikethrough: To strikethrough text use two tildes

Strikethrough text using tildes

Headings

Headings in Markdown range from 1-6 and are created using the hash or pound symbol #

H1 Heading

H2 Heading

H3 Heading

H4 Heading

H5 Heading

H6 Heading

Lists

You can organize content by using lists which can be ordered or unordered.