gemtext - a quick guide

Though this document is mostly for my own use it may be interesting to others.

Text

Write the text as it is. Let the gemini clients decide when to wrap the lines. It is good practice to write a paragraph on one single line.

html-equivalent: <p>...</p>

Emojis

It is okay to use emojis in text (copy and paste):
Smiley face 🙂

Headings

There are three levels of headings, mandatory space after the last '#'.

# Heading

## Sub-heading

### Sub-heading

html-equivalent: <h1>...</h1>, <h2>...</h2> and <h3>...</h3>

Links

One link per line, starts with '=>' followed by an optional number of whitespaces.
Optional: The link may be followed by a label separated from the link with at least one whitespace.

=> gemini://mock.link.se/mock_page.gmi gemini://mock.link.se/mock_page.gmi

=> http://another.link.com/about.html Another link (http)

html-equivalent: <a href="protocol://...>...</a>

Lists

One kind of list, unordered.
Each line starts with a '*' and with an optional space after the '*' character.

* one

* two

* three

html-equivalent:

  <ul>
    <li>one</li>
    <li>two</li>
    <li>three<li>
  </ul>

Blockquotes

Starts on a line of it's own with a '>' character.

	> This is a quote. It may be of any length as long the quote is written on a single line.

html-equivalent:

  <blockquote>
    ...
  </blockquote>

Preformatted text

Preformatted text begins with three backticks '```' on a new line and ends in the same way.

```
  Hug
      a
        tree!
```

html-equivalent: <pre>...</pre>

Sources:

Project Gemini (gemini) (gemini)
Gemini protocol documentation (html) (https)

Please report any mistakes I have done to:

📧 skf at sverro dot se
gpg key (gemini)