~kota/gemgen

A Markdown to Gemtext generator.
29 days ago
30 days ago

#gemgen - Markdown to Gemtext

builds.sr.ht status

Command line tool for converting Commonmark Markdown to Gemtext. Gemgen uses 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. 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 ~~~ 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.

I've poured hundreds of hours into gemgen and the libraries it uses, but there are no doubt still some edge cases. There's options for things like adding blank lines after headings, converting "link only" headings to links and so on. I've even added a templating system and an option for modifying links with regular expressions (to change the file extension for example). Checkout man gemgen for details.

If you have suggestions, questions, or issues drop a message in the mailing list or checkout CONTRIBUTING.md for an overview of the project and libraries.

#Packages

  • gemgen - Arch Linux (AUR)
  • gemgen - MacOS (Homebrew)

#Build

Build dependencies:

  • golang
  • make
  • sed
  • scdoc

Optionally configure config.mk to specify a different install location.
Defaults to /usr/local/

git clone https://git.sr.ht/~kota/gemgen
cd gemgen
sudo make install

#Uninstall

sudo make uninstall

#Examples

#Paragraphs

# Typeface

A typeface is the design of [lettering](https://en.wikipedia.org/wiki/Lettering)
that can include variations in size, weight (e.g. bold), slope (e.g. italic),
width (e.g. condensed), and so on. Each of these variations of the typeface is a
font. There are [thousands of different
typefaces](https://en.wikipedia.org/wiki/List_of_typefaces) in existence, with
new ones being developed constantly. The art and craft of designing typefaces is
called [_type design_](https://en.wikipedia.org/wiki/Type_design). Designers of typefaces are called [_type designers_](https://en.wikipedia.org/wiki/Type_designer) and are
often employed by [_type foundries_](https://en.wikipedia.org/wiki/Type_foundry). In digital typography, type designers are
sometimes also called _font developers_ or _font designers_.

## Popular Fonts

[DejaVu](https://dejavu-fonts.github.io/)\
[EB Garamond](https://github.com/octaviopardo/EBGaramond12)\
[Merriweather](https://fonts.google.com/specimen/Merriweather)\
[Minion](https://fonts.adobe.com/fonts/minion)\
[Palatino](https://en.wikipedia.org/wiki/Palatino)\
[PT Sans](https://en.wikipedia.org/wiki/PT_Fonts)
# Typeface

A typeface is the design of lettering that can include variations in size, weight (e.g. bold), slope (e.g. italic), width (e.g. condensed), and so on. Each of these variations of the typeface is a font. There are thousands of different typefaces in existence, with new ones being developed constantly. The art and craft of designing typefaces is called type design. Designers of typefaces are called type designers and are often employed by type foundries. In digital typography, type designers are sometimes also called font developers or font designers.

=> https://en.wikipedia.org/wiki/Lettering lettering
=> https://en.wikipedia.org/wiki/List_of_typefaces thousands of different typefaces
=> https://en.wikipedia.org/wiki/Type_design type design
=> https://en.wikipedia.org/wiki/Type_designer type designers
=> https://en.wikipedia.org/wiki/Type_foundry type foundries

## Popular Fonts

=> https://dejavu-fonts.github.io/ DejaVu
=> https://github.com/octaviopardo/EBGaramond12 EB Garamond
=> https://fonts.google.com/specimen/Merriweather Merriweather
=> https://fonts.adobe.com/fonts/minion Minion
=> https://en.wikipedia.org/wiki/Palatino Palatino
=> https://en.wikipedia.org/wiki/PT_Fonts PT Sans

#Qoutes

> When education is not liberatory, the dream of the oppressed is to be the
> oppressor. - Paulo Freire
> When education is not liberatory, the dream of the oppressed is to be the oppressor. - Paulo Freire

#Linebreaks

_A Farewell_ - Langston Hughes

With gypsies and sailors,\
Wanderers of the hills and seas,\
I go to seek my fortune.\
With pious folk and fair\
I must have a parting.\
But you will not miss me, —\
You who live between the hills\
And have never seen the seas.
A Farewell - Langston Hughes

With gypsies and sailors,
Wanderers of the hills and seas,
I go to seek my fortune.
With pious folk and fair
I must have a parting.
But you will not miss me, —
You who live between the hills
And have never seen the seas.

#Lists

* item
* item
* item

- item
  - sub-item (two spaces)
  - sub-item
- item
- item

1. one
2. two
3. three
* item
* item
* item

* item
  * sub-item (two spaces)
  * sub-item
* item
* item

* one
* two
* three