This repository has been archived by the owner on Feb 3, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathSYNTAX_REFERENCE
151 lines (89 loc) · 3.57 KB
/
SYNTAX_REFERENCE
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
=== PARAGRAPHS AND LINE BREAKS =============
Paragraphs
===========
Paragraphs are separated by a blank line. This is the first paragraph. Only put returns (enter key) in a paragraph if you want to force a line break.
Here is another paragraph, but shorter than the first.
Line breaks
-----------
Paragraphs will
contain line breaks
everywhere you type return.
=== LISTS ==================================
* rainbows
** are difficult to touch
** make me happy
* ninjas are cool
* crows are smart
# first, be the change you want to see in the world.
# then, relax.
# or perhaps take a nap instead.
=== BLOCKQUOTES ============================
Blockquotes are used to inset a block of quoted text.
bq. This is a blockquote.
> this is also a blockquote
> in 'email' style.
You can extend blockquotes for multiple paragraphs by using bq.. (note the double dots):
bq.. "There's a time when the operation of the machine becomes so odious, makes you so sick at heart, that you can't take part, you can't even passively take part, and you've got to put your bodies upon the gears and upon the wheels, upon the levers, upon all the apparatus, and you've got to make it stop!
And you've got to indicate to the people who run it, to the people who own it, that unless you're free, the machine will be prevented from working at all!"
p. Multiple paragraph blockquotes are ended with p.
=== FORMATTING =============================
_emphasis_, __italicized__, *strong*, **bold**, ??citation??, -deleted text-, +inserted text+, ^superscript^, ~subscript~, @code@, %(classname)span%
[_emphasis_], [__italicized__], [*strong*], [**bold**], [??citation??], [-deleted text-], [+inserted text+], [^superscript^], [~subscript~], [@code@]
=== LINKS ==================================
URLs become links http://riseup.net
Text [in brackets] is assumed to be a page name.
You can also point to a [different page -> trees].
Or to another [site->http://riseup.net].
To specify a different group:
* [fruit/orange] is different from [colors/orange]
* [my orange -> fruit/orange] is different from [my orange -> colors/orange]
Instead of the page name, you can use the page id number: [oranges -> +342]. It is always safe to link to a page id: it will never change.
If you want a square bracket in your text, you can disable linking \\[like so\\].
=== ANCHORS ================================
You can create anchors in text:
* a flock of crows is a [# murder #]
* but a flock of ravens is [# called a congress -> congress #]
And also link to these anchors:
* jump to [ crows -> static/greencloth #murder]
* or, more simply: [#congress]
=== HEADINGS ===============================
h1. Top level
h2. Second level
h3. Third level
Top Level
=========
Second Level
------------
=== TABLES =================================
| bird | color | locomotion |
| macaw | red | fly |
| kakapo | green | walk |
| penguin | black | swim |
Tables can be built with tabs instead of "|" and they can have headers:
_. bird _. color _. locomotion
macaw red fly
kakapo green walk
penguin black swim
=== PREFORMATTED CODE ======================
Here is some @inline code that is *not* processed@ for formatting.
<pre>
this paragraph is
preformatted
with some really impressive text.
</pre>
<code>
def fibonacci(max)
i1, i2 = 1, 1
while i1 <= max
yield i1
i1, i2 = i2, i1+i2
end
end
</code>
/-- another way to
make code blocks
\\--
@@ a single code block line
=== MACROS =================================
There are a few macros which generate special content:
[[toc]] -- table of contents