gemtext library
gemtext dart implementation
Classes
- Gemtext
- A gemtext document
- Heading
-
Lines beginning with "#" are heading lines. Heading lines consist of one,
two or three consecutive "#" characters, followed by optional whitespace,
followed by heading text. The number of # characters indicates the "level"
of header; #, ## and ### can be thought of as analogous to
<h1>,<h2>and<h3>in HTML. - Link
- Lines beginning with the two characters "=>" are link lines, which have the following syntax:
- ListItem
- Lines beginning with "* " are unordered list items. This line type exists purely for stylistic reasons. The * may be replaced in advanced clients by a bullet symbol. Any text after the "* " should be presented to the user as if it were a text line, i.e. wrapped to fit the viewport and formatted "nicely". Advanced clients can take the space of the bullet symbol into account when wrapping long list items to ensure that all lines of text corresponding to the item are offset an equal distance from the left of the screen.
- Node
- Individual nodes of the document. Each node correlates to a line in the file.
- Preformatted
- Any line whose first three characters are "```" (i.e. three consecutive back ticks with no leading whitespace) are preformatted toggle lines. These lines should NOT be included in the rendered output shown to the user. Instead, these lines toggle the parser between preformatted mode being "on" or "off". Preformatted mode should be "off" at the beginning of a document. The current status of preformatted mode is the only internal state a parser is required to maintain. When preformatted mode is "on", the usual rules for identifying line types are suspended, and all lines should be identified as preformatted text lines (see 5.4.4).
- Quote
- Lines beginning with ">" are quote lines. This line type exists so that advanced clients may use distinct styling to convey to readers the important semantic information that certain text is being quoted from an external source. For example, when wrapping long lines to the the viewport, each resultant line may have a ">" symbol placed at the front.
- Text
- Text lines are the most fundamental line type - any line which does not match the definition of another line type defined below defaults to being a text line. The majority of lines in a typical text/gemini document will be text lines.
Enums
Constants
-
gemtextFileExtensions
→ const List<
String> - gemtext file extensions
- gemtextMime → const String
- MIME type of gemtext file