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