From 0103210a1d0dc27b96f7d85a674932f59964a820 Mon Sep 17 00:00:00 2001 From: sven krause Date: Thu, 19 Dec 2024 11:05:37 +0100 Subject: [PATCH] docs: extend readme for component parameter at main-menu-docref template feat: more advanced ui sample --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8726662..f9f1acd 100644 --- a/README.md +++ b/README.md @@ -169,10 +169,6 @@ The templates are supporting the following parameter: * Menu group text -#### main-menu-group-end - -No parameter - #### main-menu-docref * `resolved` @@ -185,6 +181,8 @@ No parameter * `ref` * Resolvable (either absolute or relative to playbook base) document URI. * The parameter contains `#`, if the parameter `resolved` is marked `false`. +* `component` + * the components name (from antory.yml), if resolved, or `null` for unresolved module references. ### Sample @@ -217,7 +215,7 @@ The template `main-menu` is created by the extension as: {{> main-menu-group-end}} ``` -Find sample templates in [templates](doc/templates) folder. +Find sample templates in [templates](doc/templates) or [ui-examples](doc/ui-examples) folder.