Add post formatting help

[blerg.git] / www / doc / post_help.html

diff --git a/www/doc/post_help.html b/www/doc/post_help.html
new file mode 100644 (file)
index 0000000..a30c1f1
--- /dev/null
+++ b/www/doc/post_help.html
@@ -0,0 +1,113 @@
+<h2>Post Help</h2>
+
+<p>Blërg supports a limited subset of Markdown/wiki style formatting.
+
+<h3>Tags and Mentions</h3>
+<table class="help">
+  <tr>
+    <td>#bananas</td>
+    <td>&rArr;</td>
+    <td><a href="#/tag/bananas">#bananas</a></td>
+  </tr>
+  <tr>
+    <td>@bananymous</td>
+    <td>&rArr;</td>
+    <td><a href="#bananymous">@bananymous</a></td>
+  </tr>
+</table>
+
+<h3>Text Style</h3>
+<table class="help">
+  <tr>
+    <td>*A Christmas Carol*</td>
+    <td>&rArr;</td>
+    <td class="record">
+      <i>A Christmas Carol</i>
+    </td>
+  </tr>
+  <tr>
+    <td>**2 Legit 2 Quit**</td>
+    <td>&rArr;</td>
+    <td class="record">
+      <b>2 Legit 2 Quit</b>
+    </td>
+  </tr>
+  <tr>
+    <td># First-level Title
+    <br>## Second-level Title
+    <br>### Third-level Title
+    <br>#### Fourth-level Title
+    <br>##### Fifth-level Title
+    </td>
+    <td>&rArr;</td>
+    <td class="record">
+      <h1>First-level Title</h1>
+      <h2>Second-level Title</h2>
+      <h3>Third-level Title</h3>
+      <h4>Fourth-level Title</h4>
+      <h5>Fifth-level Title</h5>
+    </td>
+    <td>(Also works for = instead of #)</td>
+  </tr>
+</table>
+
+<h3>Lists</h3>
+<table class="help">
+  <tr>
+    <td>* one fish
+    <br>* two fish
+    <br>* red fish
+    <br>* blue fish
+    </td>
+    <td>&rArr;</td>
+    <td class="record">
+      <ul style="margin: 0">
+        <li>one fish</li>
+        <li>two fish</li>
+        <li>red fish</li>
+        <li>blue fish</li>
+      </ul>
+    </td>
+  </tr>
+</table>
+
+<h3>Quoting</h3>
+<table class="help">
+  <tr>
+    <td>&gt; Something someone else said</td>
+    <td>&rArr;</td>
+    <td class="record">
+      <div class="quote">Something someone else said</i>
+    </td>
+  </tr>
+</table>
+
+<h3>Links</h3>
+<table class="help">
+  <tr>
+    <td>http://any.url</td>
+    <td>&rArr;</td>
+    <td class="record">
+      <a href="http://any.url">http://any.url</a>
+    </td>
+  </tr>
+  <tr>
+    <td>[A Descriptive Name](http://any.url)</td>
+    <td>&rArr;</td>
+    <td class="record">
+      <a href="http://any.url">A Descriptive Name</a>
+    </td>
+  </tr>
+  <tr>
+    <td>[A Descriptive Name](http://any.url/audio.mp3)
+    <br>[A Descriptive Name](http://any.url/audio audio:mp3)</td>
+    <td>&rArr;</td>
+    <td class="record">
+      <a href="http://any.url/audio">A Descriptive Name</a>
+      <a href="http://any.url/audio" onclick="play_audio()"><img src="/images/play.png"></a>
+    </td>
+    <td>(Where the audio format is supported. Blërg recognizes mp3, ogg, and wav.)</td>
+  </tr>
+</table>
+
+<p>