From 1fd71eff13c3a01dccc5dc49c26857e84686a14c Mon Sep 17 00:00:00 2001 From: L3D Date: Sat, 11 Mar 2023 23:05:12 +0100 Subject: [PATCH] update Plugin Description --- README.md | 13 +++++++++++-- setup.py | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3aa1333..6c65c08 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ # lektor_render_template -Here will be a lektor plugin that generates files based on templates of your lektor project with filters as input string. +This is a lektor plugin, that generates files based on a Jinja2 Template. + +In this case it is expecting the [galaxy.svg](https://backwesen.de/l3d/ansible.l3d.space/src/branch/main/templates/galaxy.svg?display=source) Template and will geneate an optimzed Version of the SVG, using [scour](https://pypi.org/project/scour/). We take a dict as input with the values ``name`` to generate the output file name, ``label`` to affect the filename too and is used as first text in the svg and ``state`` text in the svg with colored background. + +## Example Usage: +```json +{'name': this.filename, 'state': this.colored_label, 'label': this.label_name} | svg +``` + +You can see a real life example of this plugin at [ansible.l3d.space](https://ansible.l3d.space/). ## Open Issues: -+ Currently the plugin does not support any config variable. ++ Currently the plugin does not support any config variable for template and variable choosing. + Currently the plugin generates the files in the assets dir. diff --git a/setup.py b/setup.py index 5b7e37f..f8b76db 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,7 @@ setup( packages=find_packages(), py_modules=['lektor_render_template'], # url='https://backwesen.de/l3d/lektor-render-template.git', - version='0.4', + version='0.5', classifiers=[ 'Framework :: Lektor', 'Environment :: Plugins',