rra/page_metadata
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
rra 2020-01-21 13:52:59 +01:00
parent 5e96200f71
commit 7c86827827
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,9 +1,17 @@
#Page Meta-Data
A plugin to add meta-data for each generated page in the format:
A Pelican plugin to add the total page size to each generated page of your site.
`index.html Tue 12 Nov 2019 03:52:15 PM CET 57.637KB`
It calculates the weight of the HTML page including all image media and returns that in a human readable format (B, KB, MB).
It calculates the weight of the HTML page including all image media. A time stamp reflecting the date of generation is also added.
## Caveats:
it currently is tailored to https://solar.lowtechmagazine.com and needs work in the following areas:
* add options to show file name and generation time
* properly handle subsites plugin (currently it only works for dither+subsites)* make sure it works with --relative-urls flag
## Use:
Add a div with id `page-size` to your template and `page_metadata` will place the result there.
have fun!
The data is appended at the end of the HTML, so nothing fancy for now.