aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2022-03-13 21:38:13 +0530
committerArun Isaac2022-04-04 14:17:03 +0530
commit8d4f4c8514c91025ec32b36f05225ede75a872bc (patch)
treecb900ec1f3b8d7393d6af8a5b610d60ba75df3b5 /doc
parentfb51be990a4bb8fb76373b519edfcf11390dcca1 (diff)
downloadskribilo-8d4f4c8514c91025ec32b36f05225ede75a872bc.tar.gz
skribilo-8d4f4c8514c91025ec32b36f05225ede75a872bc.tar.lz
skribilo-8d4f4c8514c91025ec32b36f05225ede75a872bc.zip
reader: Add Gemtext reader.gemtext-reader
* src/guile/skribilo/reader/gemtext.scm: New file. * src/guile/Makefile.am (readers): Register it. * doc/user/syntax.skb (The Gemtext Syntax): New section. * tests/readers/gemtext.test: New file. * tests/Makefile.am (TESTS): Add readers/gemtext.test.
Diffstat (limited to 'doc')
-rw-r--r--doc/user/syntax.skb21
1 files changed, 20 insertions, 1 deletions
diff --git a/doc/user/syntax.skb b/doc/user/syntax.skb
index 9a4070c..2de7cbd 100644
--- a/doc/user/syntax.skb
+++ b/doc/user/syntax.skb
@@ -211,7 +211,26 @@ documents that can be output in variety of formats (see ,(numref :text
[Chapter] :ident "engines")). The downside is that, being a very simple
markup-less document format, there are many things that cannot be done
using it, most notably tables, bibliographies, and cross-references.]))
-
+
+ (section :title [The Gemtext Syntax] :ident "gemtext-syntax"
+ (p [,(ref
+:url "https://gemini.circumlunar.space/docs/gemtext.gmi"
+:text "Gemtext"), the lightweight markup language used by the ,(ref
+:url "https://gemini.circumlunar.space" :text "Gemini protocol"), is
+supported as an input syntax. To use it, just pass ,(tt
+[--reader=gemtext]) to the compiler. When used programmatically, the
+Gemtext reader can be customized using the following options.])
+
+ (doc-markup 'make-gemtext-reader
+ '((:join-lines? [If ,(code "#t"), lines which are not
+separated by a blank line are joined into a single paragraph. This is
+a relaxation of the Gemtext standard, and is not done by default.])
+ (:section-numbers? [If ,(code "#t"), sections are
+numbered. Else, they are not.]))
+ :common-args '()
+ :source "skribilo/reader/gemtext.scm"
+ :idx *function-index*))
+
(section :title [The RSS 2.0 Syntax]
:ident "rss2-syntax"