Commit | Line | Data |
---|---|---|
1debf034 AT |
1 | %%BEGIN_PAGE_METADATA%% |
2 | [DEFAULT] | |
3 | page_title = Markdown Reference | |
4 | meta_keywords = Words,that,describe,the,page | |
5 | meta_description = A description of the page. | |
6 | %%END_PAGE_METADATA%% | |
7 | ||
957d38e8 AT |
8 | Markdown Test |
9 | ============= | |
10 | ||
11 | This document contains at least one example of each valid markdown element. It is intended as a test for the markdown processor and as a reference for content creation. | |
12 | ||
13 | --- | |
14 | ||
15 | Code Blocks | |
16 | =========== | |
17 | ||
18 | Inline `code blocks` use the backtick key while | |
19 | ||
20 | standalone code blocks use | |
21 | four spaces at the start of | |
22 | every line. | |
23 | ||
24 | --- | |
25 | ||
26 | Headers | |
27 | ======= | |
28 | ||
29 | # Header 1 | |
30 | ## Header 2 | |
31 | ### Header 3 | |
32 | #### Header 4 | |
33 | ##### Header 5 | |
34 | ###### Header 6 | |
35 | ||
36 | Alternate H1 | |
37 | ============ | |
38 | ||
39 | Alternate H2 | |
40 | ------------ | |
41 | ||
42 | --- | |
43 | ||
44 | Text Decorations | |
45 | ================ | |
46 | ||
47 | Italic emphasis is implemented with *asterisks* or _underscores_. | |
48 | ||
49 | Bold emphasis uses **double asterisks** or __double underscores__. | |
50 | ||
51 | These __*can* be__ *combined*. | |
52 | ||
53 | Strikethroughs use double ~~squigglies~~ tildes. | |
54 | ||
55 | --- | |
56 | ||
57 | Lists | |
58 | ===== | |
59 | ||
60 | 1. Lists can be both ordered or unordered. | |
61 | * This includes sublists | |
62 | * and mixed combinations | |
63 | 2. It is even possible to embed regular paragraphs in a list element. | |
64 | ||
65 | They require a leading, blank line and at least one leading space. We have used three spaces here to align the raw markdown. | |
66 | ||
67 | 3. And the list continues after the paragraph. | |
68 | 2. Note that the raw number is irrelevant; the markdown processor renumbers the list. | |
69 | ||
70 | --- | |
71 | ||
72 | Links | |
73 | ===== | |
74 | ||
75 | Links come in a variety of styles. | |
76 | ||
77 | * [Inline link](/) | |
78 | * [Inline link with title/reftext](/ "home") | |
79 | * [Reference with text][REFTEXT] | |
80 | * [Reference with number][1] | |
81 | * Triangular brackets can also define a link: <http://werc.subgeniuskitty.com> | |
82 | ||
83 | The link definition can be separate from the declaration. | |
84 | ||
85 | [REFTEXT]: http://werc.subgeniuskitty.com | |
86 | [1]: http://werc.subgeniuskitty.com | |
87 | ||
88 | --- | |
89 | ||
90 | Images | |
91 | ====== | |
92 | ||
93 | Inline style: | |
94 | ||
95 | ![alt text](/pub/images/test_img.png) | |
96 | ||
97 | Reference style: | |
98 | ||
99 | ![alt text][testimg] | |
100 | ||
101 | [testimg]: /pub/images/test_img.png | |
102 | ||
103 | --- | |
104 | ||
105 | Tables | |
106 | ====== | |
107 | ||
108 | Tables can be aligned with colons and inline markdown is allowed. | |
109 | ||
110 | | Left-align | Center-align | Right-align | | |
111 | | :--------- | :----------: | ----------------: | | |
112 | | *Italic* | **Bold** | **_Bold Italic_** | | |
113 | | And | `code` | `blocks` | | |
114 | ||
115 | --- | |
116 | ||
117 | Block Quotes | |
118 | ============ | |
119 | ||
120 | > Block quotes can be inserted with a '> ' prefix. | |
121 | ||
122 | They can be separated by normal text. | |
123 | ||
124 | > And then continue again. | |
125 |