From 8a6ec4b3fb878733c3317f9c44fb183fcf1073882bfbe665b042280f971dbee3 Mon Sep 17 00:00:00 2001 From: Nicholas Johnson Date: Fri, 29 Dec 2023 00:00:00 +0000 Subject: Write new documentation conforming to Diátaxis MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 66f8ae1..e0f09b2 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,10 @@ A live demo of the theme can be found at the following domain: [https://nicholas * English * Spanish +## Documentation + +The [gemtext compatibility reference guide](GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md) documents the compatibility of Markdown features with gemtext as an output format in of this Hugo theme. The [gemtext compatibility rationale document](GEMTEXT-COMPATIBILITY-RATIONALE.md) explains the rationale behind the design decisions for the gemtext output format. + ## Get The Theme Run from the root of your Hugo site: @@ -38,8 +42,6 @@ $ git submodule add https://git.nicholasjohnson.ch/hugo-theme-journal themes/jou To render the blog for Gemini and the Web, use separate configuration files. For guidance, look at [my journal repo](https://git.nicholasjohnson.ch/journal). -The [Gemtext compatibility document](GEMTEXT-COMPATIBILITY.md) explains which Markdown can be safely converted to Gemini. - ## Versioning This Hugo theme uses [Semantic Versioning 2.0.0](https://semver.org/). -- cgit v1.2.3