From 4291fc5f1c992a499fbc82decc3fe8090d4dff68 Mon Sep 17 00:00:00 2001
From: Brian Picciano <me@mediocregopher.com>
Date: Thu, 4 Jul 2024 12:33:45 +0200
Subject: Improve and clean up the example config for templates

---
 example/static/gemtext/cheatsheet.gmi | 62 +++++++++++++++++++++++++++++++++++
 example/static/gemtext/index.gmi      |  5 +++
 2 files changed, 67 insertions(+)
 create mode 100644 example/static/gemtext/cheatsheet.gmi
 create mode 100644 example/static/gemtext/index.gmi

(limited to 'example/static/gemtext')

diff --git a/example/static/gemtext/cheatsheet.gmi b/example/static/gemtext/cheatsheet.gmi
new file mode 100644
index 0000000..e7c9286
--- /dev/null
+++ b/example/static/gemtext/cheatsheet.gmi
@@ -0,0 +1,62 @@
+# Gemtext cheatsheet
+
+This is a quick "cheatsheet" intended for people who haven't been writing Gemtext for long or who need their memory refreshed after a break.  If you're completely new to Gemtext and you need things explained in a more detail, you should check out the full length introduction:
+
+=> gemini://geminiprotocol.net/docs/gemtext.gmi	A quick introduction to "gemtext" markup
+
+## Text
+
+Here's the basics of how text works in Gemtext:
+
+* Long lines get wrapped by the client to fit the screen
+* Short lines *don't* get joined together
+* Write paragraphs as single long lines
+* Blank lines are rendered verbatim
+
+## Links
+
+At the bare minimum, a link line consists of just the characters `=>` and a URL.  Here's a link to this page:
+
+```
+=> gemini://geminiprotocol.net/docs/cheatsheet.gmi
+```
+
+But you can include labels with links, and probably should most of the time.  Labels are separated from the URL by one or more spaces or tabs:
+
+```
+=> gemini://geminiprotocol.net/docs/cheatsheet.gmi	Gemtext cheatsheet
+```
+
+## Headings
+
+You get three levels of heading:
+
+```
+# Heading
+
+## Sub-heading
+
+### Sub-subheading
+```
+
+## Lists
+
+You get one kind of list and you can't nest them:
+
+```
+* Mercury
+* Gemini
+* Apollo
+```
+
+## Quotes
+
+Here's a quote from Maciej Cegłowski:
+
+```
+> I contend that text-based websites should not exceed in size the major works of Russian literature.
+```
+
+## Pre-fromatted text
+
+Lines which start with ``` will cause clients to toggle in and out of ordinary rendering mode and preformatted mode.  In preformatted mode, Gemtext syntax is ignored so links etc. will not be rendered, and text will appear in a monospace font.
diff --git a/example/static/gemtext/index.gmi b/example/static/gemtext/index.gmi
new file mode 100644
index 0000000..9ff3d82
--- /dev/null
+++ b/example/static/gemtext/index.gmi
@@ -0,0 +1,5 @@
+# Gemtext Directory Index
+
+This is the index of the gemtext directory. In here are various gemtext files useful for testing.
+
+=> cheatsheet.gmi Gemtext cheatsheet
-- 
cgit v1.2.3