diff options
| author | Nicholas Johnson <nick@nicholasjohnson.ch> | 2023-12-29 00:00:00 +0000 |
|---|---|---|
| committer | Nicholas Johnson <nick@nicholasjohnson.ch> | 2024-01-01 00:00:00 +0000 |
| commit | 8a6ec4b3fb878733c3317f9c44fb183fcf1073882bfbe665b042280f971dbee3 (patch) | |
| tree | 9636be7a7ca736db159454092f8c691de1e74d534caf019d2ae7d01d17f22c45 /README.md | |
| parent | c6eed1152cd5273fe8c03a295ed1adfa59223a19cd576ee16f5c4a601f859d0e (diff) | |
Write new documentation conforming to Diátaxis
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 4 insertions, 2 deletions
@@ -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/). |