code-block-pro / build / shiki / samples / markdown.sample

markdown.sample in Code Block Pro – Beautiful Syntax Highlighting 1.28.0, at build/shiki/samples/markdown.sample

162 lines 3.5 KB

Raw Download Zip

1	An h1 header
2	============
3
4	Paragraphs are separated by a blank line.
5
6	2nd paragraph. Italic, bold, and `monospace`. Itemized lists
7	look like:
8
9	* this one
10	* that one
11	* the other one
12
13	Note that --- not considering the asterisk --- the actual text
14	content starts at 4-columns in.
15
16	> Block quotes are
17	> written like so.
18	>
19	> They can span multiple paragraphs,
20	> if you like.
21
22	Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
23	in chapters 12--14"). Three dots ... will be converted to an ellipsis.
24	Unicode is supported. ☺
25
26
27
28	An h2 header
29	------------
30
31	Here's a numbered list:
32
33	1. first item
34	2. second item
35	3. third item
36
37	Note again how the actual text starts at 4 columns in (4 characters
38	from the left side). Here's a code sample:
39
40	# Let me re-iterate ...
41	for i in 1 .. 10 { do-something(i) }
42
43	As you probably guessed, indented 4 spaces. By the way, instead of
44	indenting the block, you can use delimited blocks, if you like:
45
46	~~~
47	define foobar() {
48	print "Welcome to flavor country!";
49	}
50	~~~
51
52	(which makes copying & pasting easier). You can optionally mark the
53	delimited block for Pandoc to syntax highlight it:
54
55	~~~python
56	import time
57	# Quick, count to ten!
58	for i in range(10):
59	# (but not too quick)
60	time.sleep(0.5)
61	print(i)
62	~~~
63
64
65
66	### An h3 header ###
67
68	Now a nested list:
69
70	1. First, get these ingredients:
71
72	* carrots
73	* celery
74	* lentils
75
76	2. Boil some water.
77
78	3. Dump everything in the pot and follow
79	this algorithm:
80
81	find wooden spoon
82	uncover pot
83	stir
84	cover pot
85	balance wooden spoon precariously on pot handle
86	wait 10 minutes
87	goto first step (or shut off burner when done)
88
89	Do not bump wooden spoon or it will fall.
90
91	Notice again how text always lines up on 4-space indents (including
92	that last line which continues item 3 above).
93
94	Here's a link to [a website](http://foo.bar), to a [local
95	doc](local-doc.html), and to a [section heading in the current
96	doc](#an-h2-header). Here's a footnote [^1].
97
98	[^1]: Some footnote text.
99
100	Tables can look like this:
101
102	Name Size Material Color
103	------------- ----- ------------ ------------
104	All Business 9 leather brown
105	Roundabout 10 hemp canvas natural
106	Cinderella 11 glass transparent
107
108	Table: Shoes sizes, materials, and colors.
109
110	(The above is the caption for the table.) Pandoc also supports
111	multi-line tables:
112
113	-------- -----------------------
114	Keyword Text
115	-------- -----------------------
116	red Sunsets, apples, and
117	other red or reddish
118	things.
119
120	green Leaves, grass, frogs
121	and other things it's
122	not easy being.
123	-------- -----------------------
124
125	A horizontal rule follows.
126
127	***
128
129	Here's a definition list:
130
131	apples
132	: Good for making applesauce.
133
134	oranges
135	: Citrus!
136
137	tomatoes
138	: There's no "e" in tomatoe.
139
140	Again, text is indented 4 spaces. (Put a blank line between each
141	term and its definition to spread things out more.)
142
143	Here's a "line block" (note how whitespace is honored):
144
145	\| Line one
146	\| Line too
147	\| Line tree
148
149	and images can be specified like so:
150
151	![example image](example-image.jpg "An exemplary image")
152
153	Inline math equation: $\omega = d\phi / dt$. Display
154	math should get its own line like so:
155
156	$$I = \int \rho R^{2} dV$$
157
158	And note that you can backslash-escape any punctuation characters
159	which you wish to be displayed literally, ex.: \`foo\`, \bar\, etc.
160
161	<!--- From http://www.unexpected-vortices.com/sw/rippledoc/quick-markdown-example.html -->
162