Updated with more info

This commit is contained in:
theo@manjaro 2023-01-11 21:30:44 +01:00
parent b03899bf0d
commit fa95f198a9
2 changed files with 25 additions and 35 deletions

35
README
View File

@ -1,35 +0,0 @@
# Ploum.net
This repository contains my blog posts and a script used to generate them.
Posts are separated into "fr" and "en" directories. They all should be called with YY-MM-DD-TITLE.gmi.
## Publish.py
Will goes into "fr" and "en" folders, read all YYYY-MM-DD-title.gmi files and create the following:
1. Gemini version of the blog with index in ../public_gemini
2. Html version ofthe blog with index in ../public_html using page_template.html
3. An atom feed for the blog and each language
Theres a distinction between "new" posts and "old" posts (which are from Wordpress). The reason is to keep the old URL (cool URL never change). So "new" posts are converted to "DATE-SLUG.html" while "old" posts are converted to "SLUG/index.html". But you still can make "old" posts that are more recent than some new ones.
## post-receive.sh
To be put in the distant repository to call publish.py after each git push.
(post-receive is not used on sourcehut. See build.yml instead)
## resize_image.py
Ensure pictures are not wider than 800px
## convert2gmi.py
This script takes a pelican export from Wordpress and convert it to gemini files. In a perfect world, it should be used only once. But I still keep finding problem and having to regenerate all of the "old" posts.
## send2blog.py
This script take a post and makes a mail out of it (txt+html) to send it to different mailing-list.

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# Ploum.net / webair.xyz's fork
## Features
This is a fork of Ploum's static site generator, for my personal use.
I made some slight changes to better suit my needs:
- Edits to the CSS file to ease the change of color scheme
- Better handling of header levels
- Auto-filling the author and blog names on most of the files
Key features made by Ploum:
- Support for blog posts in French and English
- Generate HTML and Gemini files
- RSS/Atom feed
For more information, see the original repo : https://sr.ht/~lioploum/ploum.net/
## Contributions
I will only maintain this for my personal use, I most probably won't accept PR on this repo. But feel free to use, copy and modify this software as you want.
## License
It is aGPLv3 licensed.