geminer/README.md

40 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2020-12-04 22:53:45 +01:00
# 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
2020-12-05 12:01:47 +01:00
* Conversion of local links
* Give your own metadata list to gather
* Custom indexes
2020-12-04 22:53:45 +01:00
* Jinja2 templating
2020-12-05 12:01:47 +01:00
## 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.
2020-12-04 22:53:45 +01:00
## Configuration
2020-12-10 16:49:47 +01:00
Soon. For now you can read [the example config](example/config.py).
2020-12-04 22:53:45 +01:00
## Gemini capsules using Geminer
2020-12-05 12:04:13 +01:00
* gemini://hashtagueule.fr
2020-12-04 22:53:45 +01:00
## TODO
* add parameter to give a function to treat local links
* clean the code (lots of work)
2020-12-05 12:01:47 +01:00
* add feed generation
2020-12-04 22:53:45 +01:00
* change configuration format?