@@ -1,14 +1,15 @@
11---
22navhome: /docs/
33next: true
4−sort: 22
4+sort: 23
55Title: Internals
66---
7−_thanks to ~rovnys-ricfer for writing the original version of this_
7+
8+_thanks to ~rovnys-ricfer for writing this_
89
910# Urbit-Flavored Markdown
1011
11−## overview
12+## Overview
1213
1314Urbit-Flavored Markdown (UFM) is a minimal markup language for creating and rendering text documents,
1415with a [Markdown](https://en.wikipedia.org/wiki/Markdown)-inspired syntax. It's integrated with the Hoon programming
@@ -19,7 +20,7 @@ using Hoon's `sail` datatype.
1920UFM is stricter than Markdown and generally supports only one syntax for each
2021type of HTML node that it emits.
2122
22−### headers
23+### Headers
2324
2425Headers in UFM begin with one or more `#` characters, followed by a space. The
2526number of leading `#`s corresponds to the resulting HTML element: `#` yields an
@@ -37,7 +38,7 @@ produces:
3738
3839 ##### Header (h5)
3940
40−### lists
41+### Lists
4142
4243A line beginning with a `-` or `+` followed by a space is interpreted as an
4344element of a list. `-` means unordered list (`<ul>`) and `+` means ordered list
@@ -87,7 +88,7 @@ produces:
8788 + nested item 1
8889 + nested item 2
8990
90−### blockquotes
91+### Blockquotes
9192
9293A section of text beginning with `> ` and indented by two spaces yields a
9394`<blockquote>` element. This blockquote can itself turn contain more UFM,
@@ -105,7 +106,7 @@ produces:
105106> > As Gregor Samsa awoke one morning from uneasy dreams
106107 he found himself _transformed_ in his bed into a *monstrous* vermin.
107108
108−### code blocks
109+### Code blocks
109110
110111By enclosing a block of text in `\`\`\` on their own lines
111112before and after the block, the text will be treated as a code block.
@@ -134,7 +135,7 @@ produces:
134135 ((x x) y)))))))
135136 ```
136137
137−### poems
138+### Poems
138139
139140A poem is a section of text with meaningful newlines. Normally in UFM,
140141newlines are treated as spaces and do not create a new line of text. If you
@@ -154,7 +155,7 @@ produces:
154155 Is moving its slow thighs, while all about it
155156 Reel shadows of the indignant desert birds.
156157
157−### sail expressions
158+### Sail expressions
158159
159160It's possible to use Urbit-Flavored Markdown as an HTML-templating language akin to
160161PHP, ERB, JSP, or Handlebars templates. This facility derives
@@ -191,7 +192,7 @@ currently does not apply `<style>` elements or element attributes,
191192which are supported in `sail` syntax. Future versions of the publishing
192193system will rectify this._
193194
194−### horizontal rules
195+### Horizontal rules
195196
196197`---` on its own line produces an `<hr>` element, the 'horizontal rule'.
197198This is rendered as a horizontal line the width of its containing paragraph.
@@ -207,12 +208,12 @@ Below the line
207208 ---
208209 Below the line
209210
210−### inline markup
211+### Inline markup
211212
212213In addition to the above, UFM includes several options for marking up
213214inline text.
214215
215−##### bold
216+##### Bold
216217
217218Enclose some text in asterisks to boldly render it inside a `<b>` element.
218219
@@ -226,7 +227,7 @@ produces:\
226227> The first rule of tautology club is
227228 *the first rule of tautology club*.
228229
229−##### italics
230+##### Italics
230231
231232Surrounding text with `_` on each side will cause it to appear
232233in italics, using an <i> element.
@@ -240,7 +241,7 @@ produces:
240241
241242Bueller? _Bueller?_
242243
243−##### double quote
244+##### Double quote
244245
245246Text enclosed in double quotes (`"`) will be rendered with
246247opening and closing quotes.
@@ -253,7 +254,7 @@ produces:\
253254
254255"Yes," he said. "That is the way with him."
255256
256−##### backslash escape
257+##### Backslash escape
257258
258259A backslash directly before a word (with no spaces) will be interpreted
259260as an escape character, causing it to be rendered raw.
@@ -268,7 +269,7 @@ produces:
268269Here is some *bold* text.
269270Here is some \*not bold\* text.
270271
271−##### trailing backslash
272+##### Trailing backslash
272273
273274A backslash at the end of a line inserts a line break (`<br>`)
274275after that line. This contrasts with the normal UFM behavior of
@@ -286,7 +287,7 @@ I wonder how long each line
286287will be if I put backslashes\
287288at the ends of the lines.
288289
289−##### inline code literal
290+##### Inline code literal
290291
291292Enclosing some text in ``` characters will cause it to be displayed as code,
292293inside a <code> element with monospace font and a different background color.
@@ -331,7 +332,7 @@ produces:\
3313320xdead.beef \
332333%term
333334
334−##### url
335+##### Url
335336
336337To insert a hyperlink, put the text content of the link in `[]` brackets
337338followed by the destination URL in `()` parentheses. Note that the text
@@ -341,9 +342,9 @@ Example:
341342
342343```
343344A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
344−is similar to an object in a traditional programming langauge.
345+is similar to an object in a traditional programming language.
345346```
346347produces:\
347348
348349A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
349−is similar to an object in a traditional programming langauge.
350+is similar to an object in a traditional programming language.