Lines Matching refs:Markdown
1 Markdown: Syntax
5 <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
6 <li><a href="/projects/markdown/basics" title="Markdown Basics">Basics</a></li>
7 <li><a class="selected" title="Markdown Syntax Documentation">Syntax</a></li>
9 <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
34 **Note:** This document is itself written using Markdown; you
45 Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
47 Readability, however, is emphasized above all else. A Markdown-formatted
50 Markdown's syntax has been influenced by several existing text-to-HTML
53 inspiration for Markdown's syntax is the format of plain text email.
62 To this end, Markdown's syntax is comprised entirely of punctuation
65 look like \*emphasis\*. Markdown lists look like, well, lists. Even
73 Markdown's syntax is intended for one purpose: to be used as a
76 Markdown is not a replacement for HTML, or even close to it. Its
80 insert. The idea for Markdown is to make it easy to read, write, and
81 edit prose. HTML is a *publishing* format; Markdown is a *writing*
82 format. Thus, Markdown's formatting syntax only addresses issues that
85 For any markup that is not covered by Markdown's syntax, you simply
87 indicate that you're switching from Markdown to HTML; you just use
93 not be indented with tabs or spaces. Markdown is smart enough not
96 For example, to add an HTML table to a Markdown article:
108 Note that Markdown formatting syntax is not processed within block-level
109 HTML tags. E.g., you can't use Markdown-style `*emphasis*` inside an
113 used anywhere in a Markdown paragraph, list item, or header. If you
114 want, you can even use HTML tags instead of Markdown formatting; e.g. if
115 you'd prefer to use HTML `<a>` or `<img>` tags instead of Markdown's
118 Unlike block-level HTML tags, Markdown syntax *is* processed within
144 Markdown allows you to use these characters naturally, taking care of
153 and Markdown will leave it alone. But if you write:
157 Markdown will translate it to:
161 Similarly, because Markdown supports [inline HTML](#html), if you use
162 angle brackets as delimiters for HTML tags, Markdown will treat them as
167 Markdown will translate it to:
171 However, inside Markdown code spans and blocks, angle brackets and
173 Markdown to write about HTML code. (As opposed to raw HTML, which is a
192 that Markdown supports "hard-wrapped" text paragraphs. This differs
197 When you *do* want to insert a `<br />` break tag using Markdown, you
201 "every line break is a `<br />`" rule wouldn't work for Markdown.
202 Markdown's email-style [blockquoting][bq] and multi-paragraph [list items][l]
212 Markdown supports two styles of headers, [Setext] [1] and [atx] [2].
249 Markdown uses email-style `>` characters for blockquoting. If you're
251 know how to create a blockquote in Markdown. It looks best if you hard
261 Markdown allows you to be lazy and only put the `>` before the first
280 Blockquotes can contain other Markdown elements, including headers, lists,
299 Markdown supports ordered (numbered) and unordered (bulleted) lists.
327 list have no effect on the HTML output Markdown produces. The HTML
328 Markdown produces from the above list is:
336 If you instead wrote the list in Markdown like this:
349 you can use ordinal numbers in your ordered Markdown lists, so that
354 list with the number 1. At some point in the future, Markdown may support
377 If list items are separated by blank lines, Markdown will wrap the
418 paragraphs, but here again, Markdown will allow you to be
461 of a code block are interpreted literally. Markdown wraps a code block
464 To produce a code block in Markdown, simply indent every line of the
471 Markdown will generate:
501 easy to include example HTML source code using Markdown -- just paste
502 it and indent it, and Markdown will handle the hassle of encoding the
516 Regular Markdown syntax is not processed within code blocks. E.g.,
518 it's also easy to use Markdown to write about Markdown's own syntax.
548 Markdown supports two style of links: *inline* and *reference*.
604 **Note:** There is a known bug in Markdown.pl 1.0.1 which prevents
617 Link definitions are only used for creating links during Markdown
649 Link definitions can be placed anywhere in your Markdown document. I
680 Markdown's inline link style:
694 With Markdown's reference-style links, a source document much more
703 Markdown treats asterisks (`*`) and underscores (`_`) as indicators of
781 tags. Markdown will turn this:
805 Markdown uses an image syntax that is intended to resemble the syntax
832 As of this writing, Markdown has no syntax for specifying the
844 Markdown supports a shortcut style for creating "automatic" links for URLs and email addresses: sim…
848 Markdown will turn this into:
853 Markdown will also perform a bit of randomized decimal and hex
855 spambots. For example, Markdown will turn this:
877 Markdown allows you to use backslash escapes to generate literal
878 characters which would otherwise have special meaning in Markdown's
885 Markdown provides backslash escapes for the following characters: