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
76 commits 1 branch 0 tags 210 KiB
Go 98.9%
Dockerfile 0.8%
Shell 0.3%
Find a file
Timur Demin 9778ada128
Parse metadata in all Hugo formats 
This makes gmnhg parse TOML/YAML/JSON/org-mode front matter in Hugo posts.

This also makes the library no longer render metadata in posts, removing
the API to do so. The metadata parsing code itself moves to
internal/gmnhg.

As the library no longer has a preset to include metadata in rendered
document, md2gmn will from now on silently discard front matter if it
encounters any.

Fixes #28. Unblocks #13.
2021-09-17 22:34:03 +05:00
.github/workflows Use no dedicated secrets in GitHub Actions 2021-09-09 17:42:58 +05:00
cmd Parse metadata in all Hugo formats 2021-09-17 22:34:03 +05:00
internal Parse metadata in all Hugo formats 2021-09-17 22:34:03 +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 Update to Go v1.16 2021-08-01 04:15:32 +05:00
go.mod Parse metadata in all Hugo formats 2021-09-17 22:34:03 +05:00
go.sum Parse metadata in all Hugo formats 2021-09-17 22:34:03 +05:00
README.md Add RSS support 2021-09-12 16:26:33 +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 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.