gdritter repos telml-markup / bfa6d49
Added example to top of readme Getty Ritter 9 years ago
1 changed file(s) with 22 addition(s) and 0 deletion(s). Collapse all Expand all
+22
-0
README.md less more
66 **This is in early phases, and so should not be relied upon for any
77 kind of stability at this stage.** In particular, the set of tags
88 and how they are understood could change radically during development.
9
10 ## Sample Document
11
12 ~~~~
13 \code{telml-markup} uses a mostly HTML-like set of names, so we create
14 \em{emphasis} with \code{\\em}, \strong{bolding} with \em{\\strong},
15 and \code{fixed-width text} with \code{\\code}.
16
17 One major difference is the \code{\\link} tag, which takes the form
18 \code{\\link\{url\|text\}},
19 \link{https://github.com/aisamanra/telml-markup|like this}.
20 ~~~~
21
22 This produces the following rendered HTML:
23
24 > <p><code>telml-markup</code> uses an HTML-like set of names, so we create
25 > <em>emphasis</em> with <code>\em</code>, <strong>bolding</strong> with <code>\strong</code>,
26 > and <code>fixed-width text</code> with <code>\code</code>.
27 > </p><p>One major difference is the <code>\link</code> tag, which takes the form
28 > <code>\link{url|text}</code>,
29 > <a href="https://github.com/aisamanra/telml-markup">like this</a>.
30 > </p>
931
1032 ## Basic Usage
1133