about summary refs log tree commit diff stats
path: root/apps/browse/README.md
blob: 0cca8522807a5f53b2ce49e6305446688167e4c7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Render a subset of Markdown.

To run:

  ```
  $ ./translate_mu apps/browse.mu
  $ ./a.elf __text_file__
  ```

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.