From 4d3615fdcc5af91729232a76df2e2264e8d03d26 Mon Sep 17 00:00:00 2001 From: Guy Godfroy Date: Sat, 5 Dec 2020 12:01:47 +0100 Subject: [PATCH] readme --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b4d67f6..b6c9aa8 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,22 @@ Geminer is a tool that was originally designed to convert a PicoCMS blog into a ## Features * Markdown to Gemtext conversion -* Custom conversion for local links (soon) -* Custom metadata gathering -* Custom indexes (for instance by tags, by authors, or any metadata you desire) +* 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](config.py.example). @@ -24,4 +35,5 @@ Soon. For now you can read [the example config](config.py.example). * add parameter to give a function to treat local links * clean the code (lots of work) +* add feed generation * change configuration format?