diff options
Diffstat (limited to 'apps')
| -rw-r--r-- | apps/browse/README.md | 11 |
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. |