Add post formatting help
[blerg.git] / www / doc / post_help.html
1 <h2>Post Help</h2>
2
3 <p>Blërg supports a limited subset of Markdown/wiki style formatting.
4
5 <h3>Tags and Mentions</h3>
6 <table class="help">
7   <tr>
8     <td>#bananas</td>
9     <td>&rArr;</td>
10     <td><a href="#/tag/bananas">#bananas</a></td>
11   </tr>
12   <tr>
13     <td>@bananymous</td>
14     <td>&rArr;</td>
15     <td><a href="#bananymous">@bananymous</a></td>
16   </tr>
17 </table>
18
19 <h3>Text Style</h3>
20 <table class="help">
21   <tr>
22     <td>*A Christmas Carol*</td>
23     <td>&rArr;</td>
24     <td class="record">
25       <i>A Christmas Carol</i>
26     </td>
27   </tr>
28   <tr>
29     <td>**2 Legit 2 Quit**</td>
30     <td>&rArr;</td>
31     <td class="record">
32       <b>2 Legit 2 Quit</b>
33     </td>
34   </tr>
35   <tr>
36     <td># First-level Title
37     <br>## Second-level Title
38     <br>### Third-level Title
39     <br>#### Fourth-level Title
40     <br>##### Fifth-level Title
41     </td>
42     <td>&rArr;</td>
43     <td class="record">
44       <h1>First-level Title</h1>
45       <h2>Second-level Title</h2>
46       <h3>Third-level Title</h3>
47       <h4>Fourth-level Title</h4>
48       <h5>Fifth-level Title</h5>
49     </td>
50     <td>(Also works for = instead of #)</td>
51   </tr>
52 </table>
53
54 <h3>Lists</h3>
55 <table class="help">
56   <tr>
57     <td>* one fish
58     <br>* two fish
59     <br>* red fish
60     <br>* blue fish
61     </td>
62     <td>&rArr;</td>
63     <td class="record">
64       <ul style="margin: 0">
65         <li>one fish</li>
66         <li>two fish</li>
67         <li>red fish</li>
68         <li>blue fish</li>
69       </ul>
70     </td>
71   </tr>
72 </table>
73
74 <h3>Quoting</h3>
75 <table class="help">
76   <tr>
77     <td>&gt; Something someone else said</td>
78     <td>&rArr;</td>
79     <td class="record">
80       <div class="quote">Something someone else said</i>
81     </td>
82   </tr>
83 </table>
84
85 <h3>Links</h3>
86 <table class="help">
87   <tr>
88     <td>http://any.url</td>
89     <td>&rArr;</td>
90     <td class="record">
91       <a href="http://any.url">http://any.url</a>
92     </td>
93   </tr>
94   <tr>
95     <td>[A Descriptive Name](http://any.url)</td>
96     <td>&rArr;</td>
97     <td class="record">
98       <a href="http://any.url">A Descriptive Name</a>
99     </td>
100   </tr>
101   <tr>
102     <td>[A Descriptive Name](http://any.url/audio.mp3)
103     <br>[A Descriptive Name](http://any.url/audio audio:mp3)</td>
104     <td>&rArr;</td>
105     <td class="record">
106       <a href="http://any.url/audio">A Descriptive Name</a>
107       <a href="http://any.url/audio" onclick="play_audio()"><img src="/images/play.png"></a>
108     </td>
109     <td>(Where the audio format is supported. Blërg recognizes mp3, ogg, and wav.)</td>
110   </tr>
111 </table>
112
113 <p>