raspbeguy
/
geminer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Python script to convert regular markdown with frontmatter to gemtext
44 Commits 1 Branch 0 Tags 152 KiB
Python 79.5%
Smarty 20.5%
Go to file
Guy Godfroy 4d3615fdcc readme 2020-12-05 12:01:47 +01:00
.gitignore first commit 2020-12-02 17:16:29 +01:00
README.md readme 2020-12-05 12:01:47 +01:00
config.py.example we need to fetch the template anyway 2020-12-04 17:19:34 +01:00
geminer.py execute black on it 2020-12-05 08:52:18 +01:00
requirements.txt add dependancies 2020-12-04 22:41:04 +01:00

README.md

Geminer

Introduction

Geminer is a tool that was originally designed to convert a PicoCMS blog into a static version for Gemini. In fact, it can act as a markdown-based static site generator.

Features

  • Markdown to Gemtext conversion
  • Conversion of local links
  • Give your own metadata list to gather
  • Custom indexes
  • Jinja2 templating

Workflow

Geminer execution can be decomposed in two steps :

  1. Parse blog posts markdown files and write gemtext translation.
  2. Generate meta pages, i.e. home page and custom indexes.

During the first step, frontmatter metadata is collected from markdown posts while gemtext posts are generated. This means that while rendering the template, a post will only have access to informations about itself.

During the second step, all metadata has been gathered, which enables creation of various indexed, which requires of course access to all posts metadata.

Configuration

Soon. For now you can read the example config.

Gemini capsules using Geminer

TODO

  • add parameter to give a function to treat local links
  • clean the code (lots of work)
  • add feed generation
  • change configuration format?