summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--examples/formatting.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/examples/formatting.txt b/examples/formatting.txt
new file mode 100644
index 0000000..40a3f78
--- /dev/null
+++ b/examples/formatting.txt
@@ -0,0 +1,24 @@
+Messages in `snac` allow a special subset of Markdown, that includes *emphasized*, **strong** and `monospaced` styles by surrounding text with one asterisk, two asterisks or backquotes, respectively.
+
+Line breaks are output as you write it.
+
+
+Prepending a less-than in a line makes it a quote:
+
+> This is quoted text
+>
+> All angle-prepended lines are grouped in the same blockquote
+
+It also allows preformatted text using three backquotes in a single line:
+
+```
+ /* this is preformatted text */
+
+ struct node {
+ struct node *prev;
+ struct node *next;
+ };
+
+```
+
+URLs like https://en.wikipedia.org/wiki/Main_Page are made clickable.