Lines Matching full:markdown
1 <h1>Markdown: Syntax</h1>
3 <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
4 <li><a href="/projects/markdown/basics" title="Markdown Basics">Basics</a></li>
5 <li><a class="selected" title="Markdown Syntax Documentation">Syntax</a></li>
6 <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>
7 <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
39 <p><strong>Note:</strong> This document is itself written using Markdown; you
40 can <a href="/projects/markdown/syntax.text">see the source for it by adding '.text' to the URL</a>.</p>
46 <p>Markdown is intended to be as easy-to-read and easy-to-write as is feasible.</p>
47 <p>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.</p>
54 <p>To this end, Markdown's syntax is comprised entirely of punctuation
57 look like *emphasis*. Markdown lists look like, well, lists. Even
62 <p>Markdown's syntax is intended for one purpose: to be used as a
64 <p>Markdown is not a replacement for HTML, or even close to it. Its
68 insert. The idea for Markdown is to make it easy to read, write, and
69 edit prose. HTML is a <em>publishing</em> format; Markdown is a <em>writing</em>
70 format. Thus, Markdown's formatting syntax only addresses issues that
72 <p>For any markup that is not covered by Markdown's syntax, you simply
74 indicate that you're switching from Markdown to HTML; you just use
79 not be indented with tabs or spaces. Markdown is smart enough not
81 <p>For example, to add an HTML table to a Markdown article:</p>
92 <p>Note that Markdown formatting syntax is not processed within block-level
93 HTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code> inside an
96 used anywhere in a Markdown paragraph, list item, or header. If you
97 want, you can even use HTML tags instead of Markdown formatting; e.g. if
98 you'd prefer to use HTML <code><a></code> or <code><img></code> tags instead of Markdown's
100 <p>Unlike block-level HTML tags, Markdown syntax <em>is</em> processed within
120 <p>Markdown allows you to use these characters naturally, taking care of
127 <p>and Markdown will leave it alone. But if you write:</p>
130 <p>Markdown will translate it to:</p>
133 <p>Similarly, because Markdown supports <a href="#html">inline HTML</a>, if you use
134 angle brackets as delimiters for HTML tags, Markdown will treat them as
138 <p>Markdown will translate it to:</p>
141 <p>However, inside Markdown code spans and blocks, angle brackets and
143 Markdown to write about HTML code. (As opposed to raw HTML, which is a
156 that Markdown supports "hard-wrapped" text paragraphs. This differs
160 <p>When you <em>do</em> want to insert a <code><br /></code> break tag using Markdown, you
163 "every line break is a <code><br /></code>" rule wouldn't work for Markdown.
164 Markdown's email-style <a href="#blockquote">blockquoting</a> and multi-paragraph <a href="#list">list items</a>
168 <p>Markdown supports two styles of headers, <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a> and <a href="http://www.aaronsw.com/2002/atx/">atx</a>.</p>
199 <p>Markdown uses email-style <code>></code> characters for blockquoting. If you're
201 know how to create a blockquote in Markdown. It looks best if you hard
210 <p>Markdown allows you to be lazy and only put the <code>></code> before the first
227 <p>Blockquotes can contain other Markdown elements, including headers, lists,
243 <p>Markdown supports ordered (numbered) and unordered (bulleted) lists.</p>
266 list have no effect on the HTML output Markdown produces. The HTML
267 Markdown produces from the above list is:</p>
274 <p>If you instead wrote the list in Markdown like this:</p>
285 you can use ordinal numbers in your ordered Markdown lists, so that
289 list with the number 1. At some point in the future, Markdown may support
308 <p>If list items are separated by blank lines, Markdown will wrap the
344 paragraphs, but here again, Markdown will allow you to be
379 of a code block are interpreted literally. Markdown wraps a code block
381 <p>To produce a code block in Markdown, simply indent every line of the
387 <p>Markdown will generate:</p>
413 easy to include example HTML source code using Markdown -- just paste
414 it and indent it, and Markdown will handle the hassle of encoding the
426 <p>Regular Markdown syntax is not processed within code blocks. E.g.,
428 it's also easy to use Markdown to write about Markdown's own syntax.</p>
452 <p>Markdown supports two style of links: <em>inline</em> and <em>reference</em>.</p>
502 <p>Link definitions are only used for creating links during Markdown
525 <p>Link definitions can be placed anywhere in your Markdown document. I
552 Markdown's inline link style:</p>
564 <p>With Markdown's reference-style links, a source document much more
571 <p>Markdown treats asterisks (<code>*</code>) and underscores (<code>_</code>) as indicators of
635 tags. Markdown will turn this:</p>
652 <p>Markdown uses an image syntax that is intended to resemble the syntax
675 <p>As of this writing, Markdown has no syntax for specifying the
683 <p>Markdown supports a shortcut style for creating "automatic" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:</p>
686 <p>Markdown will turn this into:</p>
690 Markdown will also perform a bit of randomized decimal and hex
692 spambots. For example, Markdown will turn this:</p>
708 <p>Markdown allows you to use backslash escapes to generate literal
709 characters which would otherwise have special meaning in Markdown's
715 <p>Markdown provides backslash escapes for the following characters:</p>
