From 1eef8c2cc3a179d24d83b0ee0618d248a47b9ac0 Mon Sep 17 00:00:00 2001 From: Dakota Walsh Date: Mon, 31 Jan 2022 08:45:57 +1300 Subject: [PATCH] document output to stdout Reading markdown from STDIN and writing to STDOUT was added a while ago, but unfortunately the feature broke as I wasn't using it or testing it myself. Recently, ~alterae sent a patch fixing the feature. This patch adds documentation to the README and man page. --- README.md | 4 +++- gemgen.1.scd | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 660a3c6..336b23f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ Command line tool for converting [Commonmark Markdown](https://commonmark.org/) to [Gemtext](https://gemini.circumlunar.space/docs/gemtext.gmi). Gemgen uses the [goldmark](https://pkg.go.dev/github.com/yuin/goldmark) markdown parser and [my -gemtext rendering module](https://git.sr.ht/~kota/goldmark-gemtext/). +gemtext rendering module](https://git.sr.ht/~kota/goldmark-gemtext/). You may +pass gemgen a list of files to convert and rename concurrently or pass markdown +into STDIN and get gemtext from STDOUT. The goal is to create proper _hand-made_ gemtext. Links and "autolinks" get placed below each paragraph, but a list of links is not printed twice. diff --git a/gemgen.1.scd b/gemgen.1.scd index a8e66ad..ab66e5f 100644 --- a/gemgen.1.scd +++ b/gemgen.1.scd @@ -11,7 +11,9 @@ _gemgen_ [OPTION]... [FILE]... # DESCRIPTION *gemgen* is a tool for converting Commonmark Markdown to Gemtext. Gemgen uses -the goldmark markdown parser and my gemtext rendering module. +the goldmark markdown parser and my gemtext rendering module. You may pass +gemgen a list of files to convert and rename concurrently or pass markdown into +STDIN and get gemtext from STDOUT. The goal is to create proper _hand-made_ gemtext. Links and "autolinks" get placed below each paragraph, but a list of links is not printed twice. -- 2.45.2