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
38 commits 1 branch 0 tags 210 KiB
Go 98.9%
Dockerfile 0.8%
Shell 0.3%
Find a file
Timur Demin 47e056f253
Refactor RenderMarkdown signature 
This makes the function accept a bitmask instead of a single flag. This
is a breaking change.
2020-12-12 14:03:29 +05:00
cmd Refactor RenderMarkdown signature 2020-12-12 14:03:29 +05:00
internal/gemini Fix rendering of links-only paragraphs 2020-11-20 03:59:45 +05:00
.drone.yml Add Docker build files 2020-11-21 23:19:34 +05:00
.gitignore Ignore test files from Git 2020-11-08 17:38:15 +05:00
.goreleaser.yml Release v0.1.0 2020-11-20 16:35:07 +05:00
COPYING Add README and license code under GPLv3 2020-11-11 23:21:16 +05:00
Dockerfile Add Docker build files 2020-11-21 23:19:34 +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 Add CI config and pkg.go.dev link 2020-11-20 16:20:06 +05:00
render.go Refactor RenderMarkdown signature 2020-12-12 14:03:29 +05:00

README.md

Hugo-to-Gemini converter

PkgGoDev

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.

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.