From 6d7456a85bd61810bcc5db2ba16b23604be63da5 Mon Sep 17 00:00:00 2001 From: relikd Date: Tue, 20 Dec 2022 02:45:13 +0100 Subject: [PATCH] docs: add example project --- example/Example.lektorproject | 5 +++++ example/Makefile | 7 +++++++ example/configs/inlinetags.ini | 23 +++++++++++++++++++++++ example/content/contents.lr | 3 +++ example/models/page.ini | 13 +++++++++++++ example/templates/page.html | 21 +++++++++++++++++++++ example/templates/tag-page.html | 10 ++++++++++ 7 files changed, 82 insertions(+) create mode 100644 example/Example.lektorproject create mode 100644 example/Makefile create mode 100644 example/configs/inlinetags.ini create mode 100644 example/content/contents.lr create mode 100644 example/models/page.ini create mode 100644 example/templates/page.html create mode 100644 example/templates/tag-page.html diff --git a/example/Example.lektorproject b/example/Example.lektorproject new file mode 100644 index 0000000..c6a67a6 --- /dev/null +++ b/example/Example.lektorproject @@ -0,0 +1,5 @@ +[project] +name = Inlinetags Example + +[packages] +lektor-inlinetags = 0.9.2 diff --git a/example/Makefile b/example/Makefile new file mode 100644 index 0000000..9a7864d --- /dev/null +++ b/example/Makefile @@ -0,0 +1,7 @@ +.PHONY: server clean plugins +server: + lektor server +clean: + lektor clean --yes -v +plugins: + lektor plugins flush-cache && lektor plugins list diff --git a/example/configs/inlinetags.ini b/example/configs/inlinetags.ini new file mode 100644 index 0000000..fa67f10 --- /dev/null +++ b/example/configs/inlinetags.ini @@ -0,0 +1,23 @@ +[inlinetags] +root = / +slug = tag/{key}/ +template = tag-page.html + +[inlinetags.pattern] +match = {{([^}]{1,32})}} +replace = {name} + +[inlinetags.fields] +title = "Tagged: " ~ this.key_obj + +[inlinetags.key_map] +C# = c-sharp + + +[inlinetags_hidden] +slug = hidden-tag/{key}/ +template = tag-page.html + +[inlinetags_hidden.pattern] +match = {{([^}]{1,32})}} +replace = {name} diff --git a/example/content/contents.lr b/example/content/contents.lr new file mode 100644 index 0000000..fec79e5 --- /dev/null +++ b/example/content/contents.lr @@ -0,0 +1,3 @@ +title: Use Inlinetags in {{title}}! +--- +body: This is a {{demo}} {{demo}} website that shows how to use {{Lektor}} with inline {{tags}}. Test {{C#}}. diff --git a/example/models/page.ini b/example/models/page.ini new file mode 100644 index 0000000..cf84967 --- /dev/null +++ b/example/models/page.ini @@ -0,0 +1,13 @@ +[model] +name = Page +label = {{ this.title }} + +[fields.title] +label = Title +type = string +inlinetags_hidden = true + +[fields.body] +label = Body +type = markdown +inlinetags = true diff --git a/example/templates/page.html b/example/templates/page.html new file mode 100644 index 0000000..b3bdd3e --- /dev/null +++ b/example/templates/page.html @@ -0,0 +1,21 @@ + + +Inlinetags + + +
+ {# Using "|safe" to allow clickable links in title #} +

{{ this.title|safe }}

+ {% block body %}{{ this.body }}{% endblock %} +
+ + diff --git a/example/templates/tag-page.html b/example/templates/tag-page.html new file mode 100644 index 0000000..1ba0043 --- /dev/null +++ b/example/templates/tag-page.html @@ -0,0 +1,10 @@ +{% extends "page.html" %} +{% block body %} +

Key: {{this.key}} | Object: {{this.key_obj}}

+Page with {{this.children.count()}} tag(s): + +{% endblock %}