From fdb68eddb52ad4df4480a519d756e7bf3d46bfd7 Mon Sep 17 00:00:00 2001 From: Dakota Walsh Date: Mon, 10 Jan 2022 14:28:23 +1300 Subject: [PATCH] clean up readme and man page --- README.md | 8 +++++--- gemgen.1.scd | 20 ++++++++++++++------ 2 files changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c6729e0..660a3c6 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,11 @@ Paragraphs get merged onto a single line, but hardlinks (double spaces or \ at the end of a line) will insert manual line breaks. Lists and headings get simplified to the gemtext format, emphasis markings get -removed (or kept with the `-e` option), horizontal rules get turned into 80 -character lines, and indented code gets converted to the gemtext "fenced" -format. +removed (or kept with the `-e` option), horizontal rules get turned into `~~~` +or any other string you'd like with the `-r` option, and indented code gets +converted to the gemtext "fenced" format. Commonmark markdown is fully supported +and a few common extensions have been added: autolinks, strikethrough, and wiki +style links. Gemgen includes a templating system allowing you to add headers, footers, last edit timestamps and more automatically to your output files. For exact usage diff --git a/gemgen.1.scd b/gemgen.1.scd index 4302a00..a8e66ad 100644 --- a/gemgen.1.scd +++ b/gemgen.1.scd @@ -16,13 +16,18 @@ the goldmark markdown parser and my gemtext rendering module. 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. Paragraphs get merged onto a single line, but hardlinks (double spaces or \ at -the end of a line) will insert manual line breaks. Lists and headings get -simplified to the gemtext format, emphasis markings get removed (or kept with -the *-e* option), horizontal rules get turned into 80 character lines, and -indented code gets converted to the gemtext "fenced" format. +the end of a line) will insert manual line breaks. -Commonmark markdown is fully supported and a few common extensions have been -added: autolinks, strikethrough, and wiki style links. +Lists and headings get simplified to the gemtext format, emphasis markings get +removed (or kept with the *-e* option), horizontal rules get turned into ~~~ or +any other string you'd like with *-r* option, and indented code gets converted +to the gemtext "fenced" format. Commonmark markdown is fully supported and a few +common extensions have been added: autolinks, strikethrough, and wiki style +links. + +Gemgen includes a templating system allowing you to add headers, footers, last +edit timestamps and more automatically to your output files. See *TEMPLATES* +below for details. # OPTIONS @@ -32,6 +37,9 @@ added: autolinks, strikethrough, and wiki style links. *-o, --output directory* Directory to write gemtext files. +*-r, --horizontal-rule string* + Representation of horizontal rules (default "~~~"). + *-t templates* Input file matching patterns and templates. See *TEMPLATES* for details. -- 2.45.2