md2gmi/README.md

2 KiB

md2gmi

Convert Markdown to Gemini gemtext markup with Go. Working with streams and pipes for UNIX like behavior utilizing Go channels. Processing streams line by line is slightly more complex than it needs to be as I'm playing with channels and state machines here.

Internally md2gmi does a 1st pass that constructs the blocks of single lines for gemtext. This is then streamed to the 2nd pass line by line. The 2nd pass will convert links, fix headings and stream line by line to the output sink. The sink is either a file or stdout.

Usage

Usage of ./md2gmi:
  -f string
        specify a .md (Markdown) file to read from, otherwise stdin (default)
  -o string
        specify a .gmi (gemtext) file to write to, otherwise stdout (default)

Example

go get github.com/n0x1m/md2gmi
cat file.md | md2gmi
md2gmi -i file.md -o file.gmi

The top part of this readme parses from

Convert Markdown to Gemini [gemtext](https://gemini.circumlunar.space/docs/gemtext.gmi) markup with
Go. Working with streams and pipes for UNIX like behavior utilizing Go channels. Processing streams
line by line is slightly more complex than it needs to be as I'm playing with channels and state
machines here.

> this is
a quote

<!-- testing markdown, this should be deleted, below merged -->
See the [gemini
protocol](https://gemini.circumlunar.space/) and the [protocol
spec](https://gemini.circumlunar.space/docs/specification.gmi).

to

Convert Markdown to Gemini gemtext[1] markup with Go. Working with streams and pipes for UNIX like behavior utilizing Go channels. Processing streams line by line is slightly more complex than it needs to be as I'm playing with channels and state machines here.

=> https://gemini.circumlunar.space/docs/gemtext.gmi 1: gemtext

> this is a quote
See the gemini protocol[1] and the protocol spec[2].

=> https://gemini.circumlunar.space/ 1: gemini protocol
=> https://gemini.circumlunar.space/docs/specification.gmi 2: protocol spec