Markdown
adding explanatory sentence #3
81
README.md
81
README.md
@@ -4,29 +4,31 @@ Markdown is a lightweight markup language for creating rich- or formatted text u
|
||||
|
||||
The following is a gist of Markdown example text, copied from the raw of https://raw.githubusercontent.com/mxstbr/markdown-test-file/refs/heads/master/TEST.md
|
||||
|
||||
It displays as entered in the default ("visual") editor, but is automatically escaped when switching to the "Source editor".
|
||||
|
||||
\-\-\-
|
||||
|
||||
\# Markdown: Syntax
|
||||
|
||||
\* \[Overview\]\(\#overview\)
|
||||
\* \[Philosophy\]\(\#philosophy\)
|
||||
\* \[Inline HTML\]\(\#html\)
|
||||
\* \[Automatic Escaping for Special Characters\]\(\#autoescape\)
|
||||
\* \[Philosophy\]\(\#philosophy\)
|
||||
\* \[Inline HTML\]\(\#html\)
|
||||
\* \[Automatic Escaping for Special Characters\]\(\#autoescape\)
|
||||
\* \[Block Elements\]\(\#block\)
|
||||
\* \[Paragraphs and Line Breaks\]\(\#p\)
|
||||
\* \[Headers\]\(\#header\)
|
||||
\* \[Blockquotes\]\(\#blockquote\)
|
||||
\* \[Lists\]\(\#list\)
|
||||
\* \[Code Blocks\]\(\#precode\)
|
||||
\* \[Horizontal Rules\]\(\#hr\)
|
||||
\* \[Paragraphs and Line Breaks\]\(\#p\)
|
||||
\* \[Headers\]\(\#header\)
|
||||
\* \[Blockquotes\]\(\#blockquote\)
|
||||
\* \[Lists\]\(\#list\)
|
||||
\* \[Code Blocks\]\(\#precode\)
|
||||
\* \[Horizontal Rules\]\(\#hr\)
|
||||
\* \[Span Elements\]\(\#span\)
|
||||
\* \[Links\]\(\#link\)
|
||||
\* \[Emphasis\]\(\#em\)
|
||||
\* \[Code\]\(\#code\)
|
||||
\* \[Images\]\(\#img\)
|
||||
\* \[Links\]\(\#link\)
|
||||
\* \[Emphasis\]\(\#em\)
|
||||
\* \[Code\]\(\#code\)
|
||||
\* \[Images\]\(\#img\)
|
||||
\* \[Miscellaneous\]\(\#misc\)
|
||||
\* \[Backslash Escapes\]\(\#backslash\)
|
||||
\* \[Automatic Links\]\(\#autolink\)
|
||||
\* \[Backslash Escapes\]\(\#backslash\)
|
||||
\* \[Automatic Links\]\(\#autolink\)
|
||||
|
||||
\*\*Note:\*\* This document is itself written using Markdown; you
|
||||
can \[see the source for it by adding '\.text' to the URL\]\(/projects/markdown/syntax\.text\)\.
|
||||
@@ -102,9 +104,13 @@ Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by
|
||||
adding additional levels of \`>\`:
|
||||
|
||||
\> This is the first level of quoting\.
|
||||
|
||||
>
|
||||
|
||||
\> \> This is nested blockquote\.
|
||||
|
||||
>
|
||||
|
||||
\> Back to the first level\.
|
||||
|
||||
Blockquotes can contain other Markdown elements, including headers, lists,
|
||||
@@ -176,10 +182,10 @@ But if you want to be lazy, you don't have to.
|
||||
To make lists look nice, you can wrap items with hanging indents:
|
||||
|
||||
\* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
||||
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
|
||||
viverra nec, fringilla in, laoreet vitae, risus.
|
||||
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
|
||||
viverra nec, fringilla in, laoreet vitae, risus.
|
||||
\* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
|
||||
Suspendisse id sem consectetuer libero luctus adipiscing.
|
||||
Suspendisse id sem consectetuer libero luctus adipiscing.
|
||||
|
||||
But if you want to be lazy, you don't have to:
|
||||
|
||||
@@ -194,11 +200,11 @@ paragraph in a list item must be indented by either 4 spaces
|
||||
or one tab:
|
||||
|
||||
1\. This is a list item with two paragraphs\. Lorem ipsum dolor
|
||||
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
|
||||
mi posuere lectus.
|
||||
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
|
||||
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
|
||||
sit amet velit.
|
||||
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
|
||||
mi posuere lectus.
|
||||
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
|
||||
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
|
||||
sit amet velit.
|
||||
2\. Suspendisse id sem consectetuer libero luctus adipiscing\.
|
||||
|
||||
It looks nice if you indent every line of the subsequent
|
||||
@@ -206,7 +212,7 @@ paragraphs, but here again, Markdown will allow you to be
|
||||
lazy:
|
||||
|
||||
\* This is a list item with two paragraphs.
|
||||
This is the second paragraph in the list item. You're
|
||||
This is the second paragraph in the list item. You're
|
||||
only required to indent the first line. Lorem ipsum dolor
|
||||
sit amet, consectetuer adipiscing elit.
|
||||
\* Another item in the same list.
|
||||
@@ -215,14 +221,14 @@ To put a blockquote within a list item, the blockquote's \`>\`
|
||||
delimiters need to be indented:
|
||||
|
||||
\* A list item with a blockquote:
|
||||
\> This is a blockquote
|
||||
\> inside a list item\.
|
||||
\> This is a blockquote
|
||||
\> inside a list item\.
|
||||
|
||||
To put a code block within a list item, the code block needs
|
||||
to be indented \*twice\* -- 8 spaces or two tabs:
|
||||
|
||||
\* A list item with a code block:
|
||||
\<code goes here>
|
||||
\<code goes here>
|
||||
|
||||
\#\#\# Code Blocks
|
||||
|
||||
@@ -236,13 +242,13 @@ block by at least 4 spaces or 1 tab.
|
||||
|
||||
This is a normal paragraph:
|
||||
|
||||
This is a code block.
|
||||
This is a code block.
|
||||
|
||||
Here is an example of AppleScript:
|
||||
|
||||
tell application "Foo"
|
||||
beep
|
||||
end tell
|
||||
tell application "Foo"
|
||||
beep
|
||||
end tell
|
||||
|
||||
A code block continues until it reaches a line that is not indented
|
||||
(or the end of the article).
|
||||
@@ -253,9 +259,9 @@ easy to include example HTML source code using Markdown -- just paste
|
||||
it and indent it, and Markdown will handle the hassle of encoding the
|
||||
ampersands and angle brackets. For example, this:
|
||||
|
||||
\<div class="footer">
|
||||
© 2004 Foo Corporation
|
||||
\</div>
|
||||
\<div class="footer">
|
||||
© 2004 Foo Corporation
|
||||
\</div>
|
||||
|
||||
Regular Markdown syntax is not processed within code blocks. E.g.,
|
||||
asterisks are just literal asterisks within a code block. This means
|
||||
@@ -263,7 +269,7 @@ it's also easy to use Markdown to write about Markdown's own syntax.
|
||||
|
||||
\`\`\`
|
||||
tell application "Foo"
|
||||
beep
|
||||
beep
|
||||
end tell
|
||||
\`\`\`
|
||||
|
||||
@@ -292,7 +298,7 @@ HTML \`\<em>\` tag; double \`\*\`'s or \`\_\`'s will be wrapped with an HTML
|
||||
|
||||
*single asterisks*
|
||||
|
||||
_single underscores_
|
||||
*single underscores*
|
||||
|
||||
**double asterisks**
|
||||
|
||||
@@ -305,5 +311,4 @@ To indicate a span of code, wrap it with backtick quotes (\`\` \` \`\`).
|
||||
Unlike a pre-formatted code block, a code span indicates code within a
|
||||
normal paragraph. For example:
|
||||
|
||||
Use the \`printf()\` function.
|
||||
|
||||
Use the \`printf()\` function.
|
||||
Reference in New Issue
Block a user