ren/hugo-to-gemini
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Lazy fork of https://github.com/tdemin/gmnhg
82 commits 1 branch 0 tags 210 KiB
Go 98.9%
Dockerfile 0.8%
Shell 0.3%
Find a file
Timur Demin 8135d1e0b3
Update heading renderer to latest Gemini spec 
Gemini spec p. 5.5.1 used to only allow up to three #-s in a heading
before requiring a mandatory space. It changed to an optional space in
recent updates, allowing to no longer pad Markdown H4-H6.

As clients treat everything after ### a title continuation, the renderer
will now insert H4-H6 verbatim; the end-user behavior doesn't change as
extra space means nothing for a Gemtext renderer displaying the title in
a special way.

Relates to #1.

PS: Gemini spec doesn't appear to be properly versioned, saying the
latest version is 0.14.3, 2020-11-29. The discussion on #1 clearly shows
it used to be different a while ago.
2021-09-17 23:02:46 +05:00
.github/workflows Bump Go and external deps versions 2021-09-17 22:42:28 +05:00
cmd Parse metadata in all Hugo formats 2021-09-17 22:34:03 +05:00
internal Update heading renderer to latest Gemini spec 2021-09-17 23:02:46 +05:00
.gitignore Ignore test files from Git 2020-11-08 17:38:15 +05:00
.golangci.yml Add golangci-lint config 2021-08-13 09:08:45 +05:00
.goreleaser.yml Migrate to GitHub 2021-08-01 04:11:04 +05:00
COPYING Add README and license code under GPLv3 2020-11-08 18:27:38 +05:00
Dockerfile Bump Go and external deps versions 2021-09-17 22:42:28 +05:00
go.mod Bump dependencies update 2021-09-17 22:42:45 +05:00
go.sum Bump dependencies update 2021-09-17 22:42:45 +05:00
README.md Add Go Report Card to README 2021-09-17 22:35:40 +05:00
render.go Parse metadata in all Hugo formats 2021-09-17 22:34:03 +05:00

README.md

Hugo-to-Gemini converter

PkgGoDev Go Report Card Push to GHCR

This repo holds a converter of Hugo Markdown posts to text/gemini (also named Gemtext in this README). The converter is supposed to make people using Hugo's entrance to Project Gemini, the alternate web, somewhat simpler.

The renderer is somewhat hasty, and is NOT supposed to be able to convert the entirety of possible Markdown to Gemtext (as it's not possible to do so, considering Gemtext is a lot simpler than Markdown), but instead a selected subset of it, enough for conveying your mind in Markdown.

The renderer uses the gomarkdown library for parsing Markdown. gomarkdown has a few quirks at this time, the most notable one being unable to parse links/images inside other links.

gmnhg

This program converts Hugo Markdown content files from content/ in accordance with templates found in gmnhg/ to the output dir. It also copies static files from static/ to the output dir.

For more details about the rendering process, see the doc attached to the program.

Usage of gmnhg:
  -output string
        output directory (will be created if missing) (default "output/")
  -working string
        working directory (defaults to current directory)

md2gmn

This program reads Markdown input from either text file (if -f filename is given), or stdin. The resulting Gemtext goes to stdout.

Usage of md2gmn:
  -f string
        input file

md2gmn is mainly made to facilitate testing the Gemtext renderer but can be used as a standalone program as well.

Site configuration

For RSS feeds to use correct URLs, you should define geminiBaseURL in Hugo's configuration file (config.toml, config.yaml, or config.json).

Other attributes from this file, such as site title, will also be used during RSS feed generation if they are defined.

License

This program is redistributed under the terms and conditions of the GNU General Public License, more specifically version 3 of the License. For details, see COPYING.