raspbeguy
/
geminer
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

readme

This commit is contained in:
Guy Godfroy 2020-12-05 12:01:47 +01:00
parent d38231a13d
commit 4d3615fdcc
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -7,11 +7,22 @@ Geminer is a tool that was originally designed to convert a PicoCMS blog into a
## Features ## Features
* Markdown to Gemtext conversion * Markdown to Gemtext conversion
* Custom conversion for local links (soon) * Conversion of local links
* Custom metadata gathering * Give your own metadata list to gather
* Custom indexes (for instance by tags, by authors, or any metadata you desire) * Custom indexes
* Jinja2 templating * 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 ## Configuration
Soon. For now you can read [the example config](config.py.example). 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 * add parameter to give a function to treat local links
* clean the code (lots of work) * clean the code (lots of work)
* add feed generation
* change configuration format? * change configuration format?