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
19 commits 1 branch 0 tags 210 KiB
Go 98.9%
Dockerfile 0.8%
Shell 0.3%
Find a file
Timur Demin 9ea608670f
Clarify the subset of front matter data rendered
2020-11-11 23:21:17 +05:00
cmd Add YAML front matter parsing support 2020-11-11 23:21:17 +05:00
internal/gemini Fix rendering of links as first paragraph child 2020-11-11 23:21:17 +05:00
.gitignore Ignore test files from Git 2020-11-08 17:38:15 +05:00
COPYING Add README and license code under GPLv3 2020-11-11 23:21:16 +05:00
go.mod Add YAML front matter parsing support 2020-11-11 23:21:17 +05:00
go.sum Add YAML front matter parsing support 2020-11-11 23:21:17 +05:00
README.md Update TODO in README 2020-11-11 23:21:17 +05:00
render.go Clarify the subset of front matter data rendered 2020-11-11 23:21:17 +05:00

README.md

Hugo-to-Gemini converter

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.

At this stage of development this repo contains the actual renderer (internal/gemini) and the md2gmn program that converts Markdown input to Gemtext and is supposed to facilitate testing.

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.

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

TODO

  • convert Markdown text to Gemtext
  • prepend contents of YAML front matter to Gemtext data
  • render all Hugo content files to Gemtext in accordance with front matter data and Hugo config

License

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