Artifact 5c9a46569b6e14b88e0afb954d20d4ed9fb7bc483f9b0cf1081281e58d5e5ff1:

File src/markdown.md — part of check-in [3bfdafe4aa] at 2017-07-08 20:42:48 on branch trunk — Improve built-in Markdown reference documentation to describe more features I long wished Markdown had but just now discovered it already does (user: andygoth size: 2978)

Markdown Overview

Paragraphs

Paragraphs are divided by blank lines.
End a line with two or more spaces to force a mid-paragraph line break.

Headings

# Top-level Heading                         Alternative Top Level Heading
# Top-level Heading Variant #               =============================

## Second-level Heading                     Alternative 2nd Level Heading
## Second-level Heading Variant ##          -----------------------------

Links

[display text](URL)

[display text](URL "Title")

[display text](URL 'Title')

<URL>

[display text][label]

[display text][]

URL may optionally be written <URL>. With link formats 5 and 6 ("reference links"), the URL is supplied elsewhere in the document, as shown below. Link format 6 reuses the display text as the label. Labels are case-insensitive. The title may be split onto the next line with optional indenting.

[label]: URL

[label]: URL "Title"

[label]: URL 'Title'

[label]: URL (Title)

Fonts

*italic*

_italic_

**bold**

__bold__

`code`

The `code` construct disables HTML markup, so one can write, for example, `<html>` to yield <html>.

Lists

 *   bullet item
 +   bullet item
 -   bullet item
 1.  numbered item
A two-level list is created by placing additional whitespace before the */+/-/1. of the secondary items.
 *   top-level item
   * secondary item

Block Quotes

Begin each line of a paragraph with > to block quote that paragraph.
> This paragraph is indented

> > Double-indented paragraph
Begin each line with at least four spaces or one tab to produce a verbatim code block.

Miscellaneous

In-line images are made using ![alt-text](image-URL).

Use HTML for complex formatting such as tables and forms.

Escape special characters (ex: "[", "(", "*") using backslash (ex: "\[", "\(", "\*").

A line consisting of ---, ***, or ___ is a horizontal rule. Spaces and extra -/*/_ are allowed.

See daringfireball.net for additional information.

See this page's Markdown source for more examples.

Special Features For Fossil

In hyperlinks, if the URL begins with "/" then the root of the Fossil repository is prepended. This allows for repository-relative hyperlinks.

For documents that begin with a top-level heading (ex: "# heading #"), the heading is omitted from the body of the document and becomes the document title displayed at the top of the Fossil page.