page_metadata/README.md

#Page Meta-Data

A Pelican plugin to add the total page size to each generated page of your site.

It calculates the weight of the HTML page including all image media and returns that in a human readable format (B, KB, MB).

## 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
* handle static assets


## Use:
To enable the plugin add it to the `PLUGINS` list in `pelicanconf.py`.

Add a div with id `page-size` to your template and `page_metadata` will place the result there.

have fun!


## in case we add generation time:

To use this plugin first import `strftime` at the top of `pelicanconf.py`:

`from time import strftime`

Then add `NOW = strftime('%c')` somewhere in that document as well. This saves the time of generation as a variable that is usable by the `page_metadata` plugin.
initial commit 5 years ago			`#Page Meta-Data`

update readme 4 years ago			`A Pelican plugin to add the total page size to each generated page of your site.`
initial commit 5 years ago
update readme 4 years ago			`It calculates the weight of the HTML page including all image media and returns that in a human readable format (B, KB, MB).`
initial commit 5 years ago
update readme 4 years ago			`## 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`
added readme todo, removed print statements 4 years ago			`* properly handle subsites plugin (currently it only works for dither+subsites)`
			`* make sure it works with --relative-urls flag`
			`* handle static assets`

update readme 4 years ago
			`## Use:`
merge 4 years ago			To enable the plugin add it to the `PLUGINS` list in `pelicanconf.py`.

update readme 4 years ago			Add a div with id `page-size` to your template and `page_metadata` will place the result there.

			`have fun!`
initial commit 5 years ago
merge 4 years ago
			`## in case we add generation time:`
added usage and setup instructions 5 years ago
correct wrong filename 5 years ago			To use this plugin first import `strftime` at the top of `pelicanconf.py`:
added usage and setup instructions 5 years ago
			`from time import strftime`

			Then add `NOW = strftime('%c')` somewhere in that document as well. This saves the time of generation as a variable that is usable by the `page_metadata` plugin.