From fd82826476d991bfa59203a9f073f88208819895 Mon Sep 17 00:00:00 2001 From: Karen Bradshaw Date: Mon, 7 Jan 2019 10:40:53 -0500 Subject: [PATCH] Add template for tool reference docs (#11618) * [WIP] Add template for tool reference docs - provide a template for generating tool reference docs. - use in reference-docs/gen-compdocs/generators to create consist looking markdown files for the tools. * Fix lines * remove test page --- layouts/partials/templates/tool-reference.html | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 layouts/partials/templates/tool-reference.html diff --git a/layouts/partials/templates/tool-reference.html b/layouts/partials/templates/tool-reference.html new file mode 100644 index 0000000000..291c5419ab --- /dev/null +++ b/layouts/partials/templates/tool-reference.html @@ -0,0 +1,13 @@ + +{{ partial "templates/block" (dict "page" .page "block" "overview" "purpose" "provides an overview" "optional" true) }} + +{{ .ctx.Scratch.Set "blocks" slice }} +{{ .ctx.Scratch.Add "blocks" (dict "page" .page "block" "synopsis" "heading" "Synopsis" "purpose" "describes the component") }} +{{ .ctx.Scratch.Add "blocks" (dict "page" .page "block" "options" "heading" "Options" "purpose" "lists the options for the component") }} +{{ .ctx.Scratch.Add "blocks" (dict "page" .page "block" "parentoptions" "heading" "Options from Parent Commands" "optional" true ) }} +{{ .ctx.Scratch.Add "blocks" (dict "page" .page "block" "examples" "heading" "Examples" "optional" true ) }} +{{ .ctx.Scratch.Add "blocks" (dict "page" .page "block" "body" "purpose" "the body of the page content" "optional" true) }} +{{ .ctx.Scratch.Add "blocks" (dict "content" .page.Content) }} +{{ .ctx.Scratch.Add "blocks" (dict "page" .page "block" "seealso" "heading" "See Also" "optional" true ) }} + +{{ partial "templates/blocks" . }} \ No newline at end of file