kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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
pull/11916/head
Karen Bradshaw 2019-01-07 10:40:53 -05:00 committed by Kubernetes Prow Robot
parent 6c96f7c100
commit fd82826476
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
layouts/partials/templates/tool-reference.html Normal file
View File

@ -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" . }}