git.iko.soy/urbit.org
on master help sign in
updated internals.md and arvo.md
799ffb8Robert Mariani
docs/arvo.md+1−1
compare with master
unifiedsplit
@@ -1,6 +1,6 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3−next: false
3+next: true
4sort: 6
4sort: 6
5title: Arvo
5title: Arvo
6---
6---
docs/arvo/internals.md+4−4
@@ -104,17 +104,17 @@ As of this writing, we have seven vanes, which each provide the
104following services:
104following services:
105
105
106- `%ames`: the name of both our network and the vane that communicates over
106- `%ames`: the name of both our network and the vane that communicates over
107− it
107+ it.
108−- `%behn`: a simple timer
108+- `%behn`: a simple timer.
109- `%clay`: our version-controlled, referentially- transparent, and global
109- `%clay`: our version-controlled, referentially- transparent, and global
110− filesystem
110+ filesystem.
111- `%dill`: a terminal driver. Unix sends keyboard events to `%dill` from
111- `%dill`: a terminal driver. Unix sends keyboard events to `%dill` from
112 either the console or telnet, and `%dill` produces terminal output.
112 either the console or telnet, and `%dill` produces terminal output.
113- `%eyre`: an http server. Unix sends http messages to `%eyre`, and
113- `%eyre`: an http server. Unix sends http messages to `%eyre`, and
114 `%eyre` produces http messages in response.
114 `%eyre` produces http messages in response.
115- `%ford`: handles resources and publishing.
115- `%ford`: handles resources and publishing.
116- `%gall`: manages our userspace applications. `%gall` keeps state and
116- `%gall`: manages our userspace applications. `%gall` keeps state and
117− manages subscribers
117+ manages subscribers.
118
118
119Cards
119Cards
120-----
120-----
docs/arvo/umarkdown.md+18−18
@@ -9,7 +9,7 @@ _thanks to ~rovnys-ricfer for writing this_
9
9
10# Urbit-Flavored Markdown
10# Urbit-Flavored Markdown
11
11
12−## overview
12+## Overview
13
13
14Urbit-Flavored Markdown (UFM) is a minimal markup language for creating and rendering text documents,
14Urbit-Flavored Markdown (UFM) is a minimal markup language for creating and rendering text documents,
15with a [Markdown](https://en.wikipedia.org/wiki/Markdown)-inspired syntax. It's integrated with the Hoon programming
15with a [Markdown](https://en.wikipedia.org/wiki/Markdown)-inspired syntax. It's integrated with the Hoon programming
@@ -20,7 +20,7 @@ using Hoon's `sail` datatype.
20UFM is stricter than Markdown and generally supports only one syntax for each
20UFM is stricter than Markdown and generally supports only one syntax for each
21type of HTML node that it emits.
21type of HTML node that it emits.
22
22
23−### headers
23+### Headers
24
24
25Headers in UFM begin with one or more `#` characters, followed by a space. The
25Headers in UFM begin with one or more `#` characters, followed by a space. The
26number of leading `#`s corresponds to the resulting HTML element: `#` yields an
26number of leading `#`s corresponds to the resulting HTML element: `#` yields an
@@ -38,7 +38,7 @@ produces:
38
38
39 ##### Header (h5)
39 ##### Header (h5)
40
40
41−### lists
41+### Lists
42
42
43A line beginning with a `-` or `+` followed by a space is interpreted as an
43A line beginning with a `-` or `+` followed by a space is interpreted as an
44element of a list. `-` means unordered list (`<ul>`) and `+` means ordered list
44element of a list. `-` means unordered list (`<ul>`) and `+` means ordered list
@@ -88,7 +88,7 @@ produces:
88 + nested item 1
88 + nested item 1
89 + nested item 2
89 + nested item 2
90
90
91−### blockquotes
91+### Blockquotes
92
92
93A section of text beginning with `> ` and indented by two spaces yields a
93A section of text beginning with `> ` and indented by two spaces yields a
94`<blockquote>` element. This blockquote can itself turn contain more UFM,
94`<blockquote>` element. This blockquote can itself turn contain more UFM,
@@ -106,7 +106,7 @@ produces:
106> > As Gregor Samsa awoke one morning from uneasy dreams
106> > As Gregor Samsa awoke one morning from uneasy dreams
107 he found himself _transformed_ in his bed into a *monstrous* vermin.
107 he found himself _transformed_ in his bed into a *monstrous* vermin.
108
108
109−### code blocks
109+### Code blocks
110
110
111By enclosing a block of text in `\`\`\` on their own lines
111By enclosing a block of text in `\`\`\` on their own lines
112before and after the block, the text will be treated as a code block.
112before and after the block, the text will be treated as a code block.
@@ -135,7 +135,7 @@ produces:
135 ((x x) y)))))))
135 ((x x) y)))))))
136 ```
136 ```
137
137
138−### poems
138+### Poems
139
139
140A poem is a section of text with meaningful newlines. Normally in UFM,
140A poem is a section of text with meaningful newlines. Normally in UFM,
141newlines are treated as spaces and do not create a new line of text. If you
141newlines are treated as spaces and do not create a new line of text. If you
@@ -155,7 +155,7 @@ produces:
155 Is moving its slow thighs, while all about it
155 Is moving its slow thighs, while all about it
156 Reel shadows of the indignant desert birds.
156 Reel shadows of the indignant desert birds.
157
157
158−### sail expressions
158+### Sail expressions
159
159
160It's possible to use Urbit-Flavored Markdown as an HTML-templating language akin to
160It's possible to use Urbit-Flavored Markdown as an HTML-templating language akin to
161PHP, ERB, JSP, or Handlebars templates. This facility derives
161PHP, ERB, JSP, or Handlebars templates. This facility derives
@@ -192,7 +192,7 @@ currently does not apply `<style>` elements or element attributes,
192which are supported in `sail` syntax. Future versions of the publishing
192which are supported in `sail` syntax. Future versions of the publishing
193system will rectify this._
193system will rectify this._
194
194
195−### horizontal rules
195+### Horizontal rules
196
196
197`---` on its own line produces an `<hr>` element, the 'horizontal rule'.
197`---` on its own line produces an `<hr>` element, the 'horizontal rule'.
198This is rendered as a horizontal line the width of its containing paragraph.
198This is rendered as a horizontal line the width of its containing paragraph.
@@ -208,12 +208,12 @@ Below the line
208 ---
208 ---
209 Below the line
209 Below the line
210
210
211−### inline markup
211+### Inline markup
212
212
213In addition to the above, UFM includes several options for marking up
213In addition to the above, UFM includes several options for marking up
214inline text.
214inline text.
215
215
216−##### bold
216+##### Bold
217
217
218Enclose some text in asterisks to boldly render it inside a `<b>` element.
218Enclose some text in asterisks to boldly render it inside a `<b>` element.
219
219
@@ -227,7 +227,7 @@ produces:\
227> The first rule of tautology club is
227> The first rule of tautology club is
228 *the first rule of tautology club*.
228 *the first rule of tautology club*.
229
229
230−##### italics
230+##### Italics
231
231
232Surrounding text with `_` on each side will cause it to appear
232Surrounding text with `_` on each side will cause it to appear
233in italics, using an <i> element.
233in italics, using an <i> element.
@@ -241,7 +241,7 @@ produces:
241
241
242Bueller? _Bueller?_
242Bueller? _Bueller?_
243
243
244−##### double quote
244+##### Double quote
245
245
246Text enclosed in double quotes (`"`) will be rendered with
246Text enclosed in double quotes (`"`) will be rendered with
247opening and closing quotes.
247opening and closing quotes.
@@ -254,7 +254,7 @@ produces:\
254
254
255"Yes," he said. "That is the way with him."
255"Yes," he said. "That is the way with him."
256
256
257−##### backslash escape
257+##### Backslash escape
258
258
259A backslash directly before a word (with no spaces) will be interpreted
259A backslash directly before a word (with no spaces) will be interpreted
260as an escape character, causing it to be rendered raw.
260as an escape character, causing it to be rendered raw.
@@ -269,7 +269,7 @@ produces:
269Here is some *bold* text.
269Here is some *bold* text.
270Here is some \*not bold\* text.
270Here is some \*not bold\* text.
271
271
272−##### trailing backslash
272+##### Trailing backslash
273
273
274A backslash at the end of a line inserts a line break (`<br>`)
274A backslash at the end of a line inserts a line break (`<br>`)
275after that line. This contrasts with the normal UFM behavior of
275after that line. This contrasts with the normal UFM behavior of
@@ -287,7 +287,7 @@ I wonder how long each line
287will be if I put backslashes\
287will be if I put backslashes\
288at the ends of the lines.
288at the ends of the lines.
289
289
290−##### inline code literal
290+##### Inline code literal
291
291
292Enclosing some text in ``` characters will cause it to be displayed as code,
292Enclosing some text in ``` characters will cause it to be displayed as code,
293inside a <code> element with monospace font and a different background color.
293inside a <code> element with monospace font and a different background color.
@@ -332,7 +332,7 @@ produces:\
3320xdead.beef \
3320xdead.beef \
333%term
333%term
334
334
335−##### url
335+##### Url
336
336
337To insert a hyperlink, put the text content of the link in `[]` brackets
337To insert a hyperlink, put the text content of the link in `[]` brackets
338followed by the destination URL in `()` parentheses. Note that the text
338followed by the destination URL in `()` parentheses. Note that the text
@@ -342,9 +342,9 @@ Example:
342
342
343```
343```
344A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
344A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
345−is similar to an object in a traditional programming langauge.
345+is similar to an object in a traditional programming language.
346```
346```
347produces:\
347produces:\
348
348
349A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
349A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
350−is similar to an object in a traditional programming langauge.
350+is similar to an object in a traditional programming language.
docs/arvo/umarkdown.umd+21−20
@@ -1,14 +1,15 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3next: true
3next: true
4−sort: 22
4+sort: 23
5Title: Internals
5Title: Internals
6---
6---
7+
7−_thanks to ~rovnys-ricfer for writing the original version of this_
8+_thanks to ~rovnys-ricfer for writing this_
8
9
9# Urbit-Flavored Markdown
10# Urbit-Flavored Markdown
10
11
11−## overview
12+## Overview
12
13
13Urbit-Flavored Markdown (UFM) is a minimal markup language for creating and rendering text documents,
14Urbit-Flavored Markdown (UFM) is a minimal markup language for creating and rendering text documents,
14with a [Markdown](https://en.wikipedia.org/wiki/Markdown)-inspired syntax. It's integrated with the Hoon programming
15with 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.
19UFM is stricter than Markdown and generally supports only one syntax for each
20UFM is stricter than Markdown and generally supports only one syntax for each
20type of HTML node that it emits.
21type of HTML node that it emits.
21
22
22−### headers
23+### Headers
23
24
24Headers in UFM begin with one or more `#` characters, followed by a space. The
25Headers in UFM begin with one or more `#` characters, followed by a space. The
25number of leading `#`s corresponds to the resulting HTML element: `#` yields an
26number of leading `#`s corresponds to the resulting HTML element: `#` yields an
@@ -37,7 +38,7 @@ produces:
37
38
38 ##### Header (h5)
39 ##### Header (h5)
39
40
40−### lists
41+### Lists
41
42
42A line beginning with a `-` or `+` followed by a space is interpreted as an
43A line beginning with a `-` or `+` followed by a space is interpreted as an
43element of a list. `-` means unordered list (`<ul>`) and `+` means ordered list
44element of a list. `-` means unordered list (`<ul>`) and `+` means ordered list
@@ -87,7 +88,7 @@ produces:
87 + nested item 1
88 + nested item 1
88 + nested item 2
89 + nested item 2
89
90
90−### blockquotes
91+### Blockquotes
91
92
92A section of text beginning with `> ` and indented by two spaces yields a
93A section of text beginning with `> ` and indented by two spaces yields a
93`<blockquote>` element. This blockquote can itself turn contain more UFM,
94`<blockquote>` element. This blockquote can itself turn contain more UFM,
@@ -105,7 +106,7 @@ produces:
105> > As Gregor Samsa awoke one morning from uneasy dreams
106> > As Gregor Samsa awoke one morning from uneasy dreams
106 he found himself _transformed_ in his bed into a *monstrous* vermin.
107 he found himself _transformed_ in his bed into a *monstrous* vermin.
107
108
108−### code blocks
109+### Code blocks
109
110
110By enclosing a block of text in `\`\`\` on their own lines
111By enclosing a block of text in `\`\`\` on their own lines
111before and after the block, the text will be treated as a code block.
112before and after the block, the text will be treated as a code block.
@@ -134,7 +135,7 @@ produces:
134 ((x x) y)))))))
135 ((x x) y)))))))
135 ```
136 ```
136
137
137−### poems
138+### Poems
138
139
139A poem is a section of text with meaningful newlines. Normally in UFM,
140A poem is a section of text with meaningful newlines. Normally in UFM,
140newlines are treated as spaces and do not create a new line of text. If you
141newlines are treated as spaces and do not create a new line of text. If you
@@ -154,7 +155,7 @@ produces:
154 Is moving its slow thighs, while all about it
155 Is moving its slow thighs, while all about it
155 Reel shadows of the indignant desert birds.
156 Reel shadows of the indignant desert birds.
156
157
157−### sail expressions
158+### Sail expressions
158
159
159It's possible to use Urbit-Flavored Markdown as an HTML-templating language akin to
160It's possible to use Urbit-Flavored Markdown as an HTML-templating language akin to
160PHP, ERB, JSP, or Handlebars templates. This facility derives
161PHP, ERB, JSP, or Handlebars templates. This facility derives
@@ -191,7 +192,7 @@ currently does not apply `<style>` elements or element attributes,
191which are supported in `sail` syntax. Future versions of the publishing
192which are supported in `sail` syntax. Future versions of the publishing
192system will rectify this._
193system will rectify this._
193
194
194−### horizontal rules
195+### Horizontal rules
195
196
196`---` on its own line produces an `<hr>` element, the 'horizontal rule'.
197`---` on its own line produces an `<hr>` element, the 'horizontal rule'.
197This is rendered as a horizontal line the width of its containing paragraph.
198This is rendered as a horizontal line the width of its containing paragraph.
@@ -207,12 +208,12 @@ Below the line
207 ---
208 ---
208 Below the line
209 Below the line
209
210
210−### inline markup
211+### Inline markup
211
212
212In addition to the above, UFM includes several options for marking up
213In addition to the above, UFM includes several options for marking up
213inline text.
214inline text.
214
215
215−##### bold
216+##### Bold
216
217
217Enclose some text in asterisks to boldly render it inside a `<b>` element.
218Enclose some text in asterisks to boldly render it inside a `<b>` element.
218
219
@@ -226,7 +227,7 @@ produces:\
226> The first rule of tautology club is
227> The first rule of tautology club is
227 *the first rule of tautology club*.
228 *the first rule of tautology club*.
228
229
229−##### italics
230+##### Italics
230
231
231Surrounding text with `_` on each side will cause it to appear
232Surrounding text with `_` on each side will cause it to appear
232in italics, using an <i> element.
233in italics, using an <i> element.
@@ -240,7 +241,7 @@ produces:
240
241
241Bueller? _Bueller?_
242Bueller? _Bueller?_
242
243
243−##### double quote
244+##### Double quote
244
245
245Text enclosed in double quotes (`"`) will be rendered with
246Text enclosed in double quotes (`"`) will be rendered with
246opening and closing quotes.
247opening and closing quotes.
@@ -253,7 +254,7 @@ produces:\
253
254
254"Yes," he said. "That is the way with him."
255"Yes," he said. "That is the way with him."
255
256
256−##### backslash escape
257+##### Backslash escape
257
258
258A backslash directly before a word (with no spaces) will be interpreted
259A backslash directly before a word (with no spaces) will be interpreted
259as an escape character, causing it to be rendered raw.
260as an escape character, causing it to be rendered raw.
@@ -268,7 +269,7 @@ produces:
268Here is some *bold* text.
269Here is some *bold* text.
269Here is some \*not bold\* text.
270Here is some \*not bold\* text.
270
271
271−##### trailing backslash
272+##### Trailing backslash
272
273
273A backslash at the end of a line inserts a line break (`<br>`)
274A backslash at the end of a line inserts a line break (`<br>`)
274after that line. This contrasts with the normal UFM behavior of
275after that line. This contrasts with the normal UFM behavior of
@@ -286,7 +287,7 @@ I wonder how long each line
286will be if I put backslashes\
287will be if I put backslashes\
287at the ends of the lines.
288at the ends of the lines.
288
289
289−##### inline code literal
290+##### Inline code literal
290
291
291Enclosing some text in ``` characters will cause it to be displayed as code,
292Enclosing some text in ``` characters will cause it to be displayed as code,
292inside a <code> element with monospace font and a different background color.
293inside a <code> element with monospace font and a different background color.
@@ -331,7 +332,7 @@ produces:\
3310xdead.beef \
3320xdead.beef \
332%term
333%term
333
334
334−##### url
335+##### Url
335
336
336To insert a hyperlink, put the text content of the link in `[]` brackets
337To insert a hyperlink, put the text content of the link in `[]` brackets
337followed by the destination URL in `()` parentheses. Note that the text
338followed by the destination URL in `()` parentheses. Note that the text
@@ -341,9 +342,9 @@ Example:
341
342
342```
343```
343A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
344A [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.
345```
346```
346produces:\
347produces:\
347
348
348A [Hoon `core`](https://urbit.org/docs/hoon/concepts/#-core-object)
349A [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.