about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorKartik Agaram <vc@akkartik.com>2020-09-11 16:11:04 -0700
committerKartik Agaram <vc@akkartik.com>2020-09-11 16:11:04 -0700
commite99f527da03b1b1556af2f01e16ad3e6c0f37f8c (patch)
treee5556e605650071f1dcc40b1c012e82f51a9aaab
parent91a5f3e10300fd84db26690095329592de0942d7 (diff)
downloadmu-e99f527da03b1b1556af2f01e16ad3e6c0f37f8c.tar.gz
6775
-rw-r--r--apps/browse/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/apps/browse/README.md b/apps/browse/README.md
index 776ec2de..0cca8522 100644
--- a/apps/browse/README.md
+++ b/apps/browse/README.md
@@ -8,3 +8,14 @@ To run:
   ```
 
 Press 'q' to quit. All other keys scroll down.
+
+## Format restrictions
+
+This is a fairly tiny subset of GitHub-Flavored Markdown. Things supported so
+far:
+
+* Newlines are mostly ignored. Double newlines are rendered (paragraphs).
+  Newlines followed by indentation are rendered.
+* Paragraphs starting with runs of `#` represent headings.
+* Within a line characters, between `*`s or `_`s represent bolded text. No
+  italics.