You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This guide is a very brief overview, with examples, of the syntax that [Markdown] supports. It is itself written in Markdown and you can copy the samples over to the left-hand pane for experimentation. It's shown as *text* and not *rendered HTML*.
4
+
This guide is a very brief overview, with examples, of the syntax that [Markdown] supports. It is itself written in Markdown and you can copy the samples over to the left-hand pane for experimentation. It's shown as *text* and not *rendered HTML*.
First thing is first. You can use *stars* or _underscores_ for italics. **Double stars** and __double underscores__do bold. ***Three together***do___both___.
12
+
First thing is first. You can use *stars* or _underscores_ for italics. **Double stars** and __double underscores__for bold. ***Three together***for___both___.
13
13
14
-
Paragraphs are pretty easy too. Just have a blank line between chunks of text.
14
+
Paragraphs are pretty easy too. Just have a blank line between chunks of text.
15
15
16
-
> This chunk of text is in a block quote. Its multiple lines will all be
16
+
> This chunk of text is in a block quote. Its multiple lines will all be
17
17
> indented a bit from the rest of the text.
18
18
>
19
19
> > Multiple levels of block quotes also work.
20
20
21
-
Sometimes you want to include some code, such as when you are explaining how `<h1>` HTML tags work, or maybe you are a programmer and you are discussing `someMethod()`.
21
+
Sometimes you want to include code, such as when you are explaining how `<h1>` HTML tags work, or maybe you are a programmer and you are discussing `someMethod()`.
22
22
23
-
If you want to include some code and have
24
-
newlines preserved, indent the line with a tab
25
-
or at least four spaces.
23
+
If you want to include code and have new
24
+
lines preserved, indent the line with a tab
25
+
or at least four spaces:
26
26
27
27
Extra spaces work here too.
28
-
This is also called preformatted text and it is useful for showing examples.
29
-
28
+
This is also called preformatted text and it is useful for showing examples.
30
29
The text will stay as text, so any *markdown* or <u>HTML</u> you add will
31
-
not show up formatted.
32
-
This way you can show markdown examples in a
33
-
markdown document.
30
+
not show up formatted. This way you can show markdown examples in a
31
+
markdown document.
34
32
35
33
> You can also use preformatted text with your blockquotes
36
34
> as long as you add at least five spaces.
@@ -39,7 +37,7 @@ markdown document.
39
37
Headings
40
38
========
41
39
42
-
There are a couple of ways to make headings. Using three or more equals signs on a line under a heading makes it into an "h1" style. Three or more hyphens under a line makes it "h2" (slightly smaller). You can also use multiple pound symbols before and after a heading. Pounds after the title are ignored. Here's some examples:
40
+
There are a couple of ways to make headings. Using three or more equals signs on a line under a heading makes it into an "h1" style. Three or more hyphens under a line makes it "h2" (slightly smaller). You can also use multiple pound symbols (`#`) before and after a heading. Pounds after the title are ignored. Here are some examples:
43
41
44
42
This is H1
45
43
==========
@@ -58,20 +56,20 @@ This is H2
58
56
Links
59
57
=====
60
58
61
-
Let's link to a few sites. First, let's use the bare URL, like <http://www.github.com>. Great for text, but ugly for HTML.
62
-
Next is an inline link to [Google](http://www.google.com). A little nicer.
59
+
Let's link to a few sites. First, let's use the bare URL, like <https://www.github.com>. Great for text, but ugly for HTML.
60
+
Next is an inline link to [Google](https://www.google.com). A little nicer.
63
61
This is a reference-style link to [Wikipedia][1].
64
-
Lastly, here's a pretty link to [Yahoo]. The reference-style and pretty links both automatically use the links defined below, but they could be defined *anywhere* in the markdown and are removed from the HTML. The names are also case insensitive, so you can use [YaHoO] and have it link properly.
62
+
Lastly, here's a pretty link to [Yahoo]. The reference-style and pretty links both automatically use the links defined below, but they could be defined *anywhere* in the markdown and are removed from the HTML. The names are also case insensitive, so you can use [YaHoO] and have it link properly.
65
63
66
-
[1]: http://www.wikipedia.org/
67
-
[Yahoo]: http://www.yahoo.com/
64
+
[1]: https://www.wikipedia.org/
65
+
[Yahoo]: https://www.yahoo.com/
68
66
69
67
Title attributes may be added to links by adding text after a link.
70
-
This is the [inline link](http://www.bing.com"Bing") with a "Bing" title.
68
+
This is the [inline link](https://www.bing.com"Bing") with a "Bing" title.
71
69
You can also go to [W3C][2] and maybe visit a [friend].
72
70
73
-
[2]: http://w3c.org(The W3C puts out specs for web-based things)
74
-
[Friend]: http://facebook.com/"Facebook!"
71
+
[2]: https://w3c.org(The W3C puts out specs for web-based things)
Email addresses wrapped in angle brackets are linked: <[email protected]>.
@@ -86,12 +84,12 @@ Lists
86
84
- You can also use hyphens
87
85
+ Or plus symbols
88
86
89
-
The above is an "unordered" list. Now, on for a bit of order.
87
+
The above is an "unordered" list. Now, on for a bit of order.
90
88
91
89
1. Numbered lists are also easy
92
90
2. Just start with a number
93
91
3738762. However, the actual number doesn't matter when converted to HTML.
94
-
1.This will still show up as 4.
92
+
1. This will still show up as 4.
95
93
96
94
You might want a few advanced lists:
97
95
@@ -103,37 +101,39 @@ You might want a few advanced lists:
103
101
- This nested list also has blank lines between the list items.
104
102
105
103
- How to create nested lists
106
-
1. Start your regular list
107
-
2.Indent nested lists with four spaces
108
-
3.Further nesting means you should indent with four more spaces
109
-
* This line is indented with eight spaces.
104
+
1. Start your regular list
105
+
2. Indent nested lists with two spaces
106
+
3. Further nesting means you should indent with two more spaces
107
+
* This line is indented with four spaces.
110
108
111
-
- List items can be quite lengthy. You can keep typing and either continue
109
+
- List items can be quite lengthy. You can keep typing and either continue
112
110
them on the next line with no indentation.
113
111
114
112
- Alternately, if that looks ugly, you can also
115
113
indent the next line a bit for a prettier look.
116
114
117
-
- You can put large blocks of text in your list by just indenting with four spaces.
115
+
- You can put large blocks of text in your list by just indenting with two spaces.
116
+
117
+
This is formatted the same as code, but you can inspect the HTML
118
+
and find that it's just wrapped in a `<p>` tag and *won't* be shown
119
+
as preformatted text.
118
120
119
-
This is formatted the same as code, but you can inspect the HTML
120
-
and find that it's just wrapped in a `<p>` tag and *won't* be shown
121
-
as preformatted text.
121
+
You can keep adding more and more paragraphs to a single
122
+
list item by adding the traditional blank line and then keep
123
+
on indenting the paragraphs with two spaces.
122
124
123
-
You can keep adding more and more paragraphs to a single
124
-
list item by adding the traditional blank line and then keep
125
-
on indenting the paragraphs with four spaces. You really need
126
-
to only indent the first line, but that looks ugly.
125
+
You really only need to indent the first line,
126
+
but that looks ugly.
127
127
128
128
- Lists support blockquotes
129
129
130
-
> Just like this example here. By the way, you can
131
-
> nest lists inside blockquotes!
132
-
> - Fantastic!
130
+
> Just like this example here. By the way, you can
131
+
> nest lists inside blockquotes!
132
+
> - Fantastic!
133
133
134
134
- Lists support preformatted text
135
135
136
-
You just need to indent eight spaces.
136
+
You just need to indent an additional four spaces.
137
137
138
138
139
139
Even More
@@ -142,29 +142,30 @@ Even More
142
142
Horizontal Rule
143
143
---------------
144
144
145
-
If you need a horizontal rule you just need to put at least three hyphens, asterisks, or underscores on a line by themselves. You can also even put spaces between the characters.
145
+
If you need a horizontal rule you just need to put at least three hyphens, asterisks, or underscores on a line by themselves. You can also even put spaces between the characters.
146
146
147
147
---
148
148
****************************
149
149
_ _ _ _ _ _ _
150
150
151
-
Those three all produced horizontal lines. Keep in mind that three hyphens under any text turns that text into a heading, so add a blank line if you use hyphens.
151
+
Those three all produced horizontal lines. Keep in mind that three hyphens under any text turns that text into a heading, so add a blank like if you use hyphens.
152
152
153
153
Images
154
154
------
155
155
156
-
Images work exactly like links, but they have exclamation points in front. They work with references and titles too.
156
+
Images work exactly like links, but they have exclamation points in front. They work with references and titles too.
157
157
158
-
 and ![Happy].
158
+
 and ![Happy].
If markdown is too limiting, you can just insert your own <strike>crazy</strike> HTML. Span-level HTML <u>can *still* use markdown</u>. Block level elements must be separated from text by a blank line and must not have any spaces before the opening and closing HTML.
166
+
If markdown is too limiting, you can just insert your own <strike>crazy</strike> HTML. Span-level HTML <u>can *still* use markdown</u>. Block level elements must be separated from text by a blank line and must not have any spaces before the opening and closing HTML.
0 commit comments