Compare commits

...

2 Commits

Author SHA1 Message Date
Guy Godfroy 2045f36df0 add README 2020-12-04 22:53:45 +01:00
Guy Godfroy 3f52ec9531 add dependancies 2020-12-04 22:41:04 +01:00
2 changed files with 31 additions and 0 deletions

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# 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
* Custom conversion for local links (soon)
* Custom metadata gathering
* Custom indexes (for instance by tags, by authors, or any metadata you desire)
* Jinja2 templating
## Configuration
Soon. For now you can read [the example config](config.py.example).
## Gemini capsules using Geminer
* [Hashtagueule](gemini://hashtagueule.fr)
## TODO
* add parameter to give a function to treat local links
* clean the code (lots of work)
* change configuration format?

4
requirements.txt Normal file
View File

@ -0,0 +1,4 @@
Jinja2
md2gemini
python-frontmatter
python-slugify