-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
322 lines (278 loc) · 9.69 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"
/>
<link rel="stylesheet" href="./assets/style.css" />
<title>Markdown Docs</title>
<!-- CONTENT RESOURCE -->
<!-- https://guides.github.com/features/mastering-markdown/ -->
</head>
<body>
<div class="grid border-rounded">
<nav id="navbar" class="border-rounded">
<header>
<h1>
MD Documentation
</h1>
</header>
<ul class="border-rounded">
<li>
<a class="nav-link" href="#Introduction">Introduction</a>
</li>
<li>
<a class="nav-link" href="#What_Is_Markdown?">What is Markdown?</a>
</li>
<li>
<a class="nav-link" href="#Examples">Examples</a>
</li>
<li>
<a class="nav-link" href="#Syntax_guide">Syntax guide</a>
</li>
<li>
<a class="nav-link" href="#GitHub_Flavored_Markdown"
>GitHub Flavored Markdown</a
>
</li>
<li>
<a class="nav-link" href="#Markdown_Resources"
>Markdown Resources</a
>
</li>
</ul>
</nav>
<main id="main-doc" class="border-rounded">
<section id="Introduction" class="main-section">
<header>
<h2>
Introduction
</h2>
</header>
<p>
Markdown is a lightweight and easy-to-use syntax for styling all
forms of writing on the GitHub platform.
</p>
<strong>
What you will learn:
</strong>
<ul>
<li>
How the Markdown format makes styled collaborative editing easy
</li>
<li>
How Markdown differs from traditional formatting approaches
</li>
<li>
How to use Markdown to format text
</li>
<li>
How to leverage GitHub’s automatic Markdown rendering
</li>
<li>
How to apply GitHub’s unique Markdown extensions
</li>
</ul>
</section>
<section id="What_Is_Markdown?" class="main-section">
<header>
<h2>What is Markdown?</h2>
</header>
<p>
<a href="http://daringfireball.net/projects/markdown/">Markdown</a>
is a way to style text on the web. You control the display of the
document; formatting words as bold or italic, adding images, and
creating lists are just a few of the things we can do with Markdown.
Mostly, Markdown is just regular text with a few non-alphabetic
characters thrown in, like <code class="">#</code> or
<code class="">*</code>.
</p>
<p>You can use Markdown most places around GitHub:</p>
<ol>
<li><a href="https://gist.github.com/">Gists</a></li>
<li>Comments in Issues and Pull Requests</li>
<li>
Files with the <code>.md</code> or
<code>.markdown</code> extension
</li>
</ol>
<p>
For more information, see
<a href="https://help.github.com/categories/writing-on-github/"
>“Writing on GitHub”</a
>
on GitHub in the help sub domain.
</p>
</section>
<section id="Examples" class="main-section">
<header>
<h2>Examples</h2>
</header>
<section>
<h3>Text</h3>
<div class="example">
<pre class="markdown">
<code>
It's very easy to make some words **bold** and other words *italic* with Markdown. You can even
<span style="white-space:nowrap">[link to Google!](http://google.com)</span>
</code>
</pre>
<p class="rendered">
It's very easy to make some words <strong>bold</strong> and
other words <i>italic</i> with Markdown. You can even
<a href="https://www.google.com/">link to Google!</a>
</p>
</div>
</section>
<section>
<h3>Lists</h3>
<div class="example">
<pre class="markdown">
<code>
Sometimes you want numbered lists:
1. One
2. Two
3. Three
Sometimes you want bullet points:
* Start a line with a star
* Profit!
Alternatively,
- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this
</code>
</pre>
<div class="rendered">
<p>Sometimes you want numbered lists:</p>
<ol>
<li>One</li>
<li>Two</li>
<li>Three</li>
</ol>
<p>Sometimes you want bullet points:</p>
<ul>
<li>Start a line with a star</li>
<li>Profit!</li>
</ul>
<p>Alternatively,</p>
<ul>
<li>Dashes work just as well</li>
<li>
And if you have sub points, put two spaces before the dash
or star:
<ul>
<li>Like this</li>
<li>And this</li>
</ul>
</li>
</ul>
</div>
</div>
</section>
<section>
<h3>Images</h3>
<div class="example">
<pre class="markdown">
<code>
If you want to embed images, this is how you do it:
</code>
</pre>
<div class="rendered">
<p>
If you want to embed images, this is how you do it:
</p>
<img src="./assets/cat-640.jpg" alt="white cat" />
</div>
</div>
</section>
<section>
<h3>Headers & Quotes</h3>
<div class="example">
<pre class="markdown">
<code>
# Structured documents
Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.
### This is a third-tier heading
You can use one `#` all the way up to `######` six for different heading sizes.
If you'd like to quote someone, use the > character before the line:
> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
> - Captain Janeway
</code>
</pre>
<div class="rendered">
<h1>Structured documents</h1>
<p>
Sometimes it’s useful to have different levels of headings to
structure your documents. Start lines with a <code>#</code> to
create headings. Multiple <code>##</code> in a row denote
smaller heading sizes.
</p>
<h3>This is a third-tier heading</h3>
<p>
You can use one <code>#</code> all the way up to
<code>######</code> six for different heading sizes.
</p>
<p>
If you’d like to quote someone, use the > character before
the line:
</p>
<blockquote>
<p>
Coffee. The finest organic suspension ever devised… I beat
the Borg with it. - Captain Janeway
</p>
</blockquote>
</div>
</div>
</section>
</section>
<section id="Syntax_guide" class="main-section">
<header>
<h2>Syntax guide</h2>
</header>
<p>Here’s an overview of Markdown syntax.</p>
<div>
<h3>Headers</h3>
<pre class="highlight">
<code>
<span class="gh"># This is an <h1> tag</span>
<span class="gu">## This is an <h2> tag</span>
<span class="gu">###### This is an <h6> tag</span>
</code>
</pre>
</div>
</section>
<section id="GitHub_Flavored_Markdown" class="main-section">
<header>
<h2>GitHub Flavored Markdown</h2>
</header>
<div>
<p>
GitHub.com uses its own version of the Markdown syntax that
provides an additional set of useful features, many of which make
it easier to work with content on GitHub.com.
</p>
<p>
Note that some features of GitHub Flavored Markdown are only
available in the descriptions and comments of Issues and Pull
Requests. These include @mentions as well as references to SHA-1
hashes, Issues, and Pull Requests. Task Lists are also available
in Gist comments and in Gist Markdown files.
</p>
</div>
</section>
<section id="Markdown_Resources" class="main-section">
<header>
<h2>Markdown Resources</h2>
</header>
</section>
</main>
</div>
<!-- freeCodeCamp Test Suites -->
<script src="https://cdn.freecodecamp.org/testable-projects-fcc/v1/bundle.js"></script>
</body>
</html>