Usage docs (#501)
* Add setup and usage docs Signed-off-by: lucperkins <lucperkins@gmail.com> * Finish initial version of setup doc * Add YAML config file for CLI docs * Finish CLI shortcode Signed-off-by: lucperkins <lucperkins@gmail.com> * Fix scrolling on mobile Signed-off-by: lucperkins <lucperkins@gmail.com> * Finish first version of usage doc Signed-off-by: lucperkins <lucperkins@gmail.com> * Remove go install section, modify CSS for CLI docs, and fix typo Signed-off-by: lucperkins <lucperkins@gmail.com>
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
{{ partial "docs/header.html" . }}
|
||||
|
||||
<section class="section">
|
||||
<div class="content is-medium">
|
||||
<div class="content">
|
||||
{{ .Content }}
|
||||
</div>
|
||||
</section>
|
||||
|
||||
57
website/layouts/shortcodes/cli.html
Normal file
57
website/layouts/shortcodes/cli.html
Normal file
@@ -0,0 +1,57 @@
|
||||
{{ $cli := .Site.Data.cli }}
|
||||
{{ $description := $cli.description | markdownify }}
|
||||
{{ $flags := $cli.flags }}
|
||||
<div class="cli">
|
||||
<span class="cli-title" id="virtual-kubelet-cli">
|
||||
<h2>
|
||||
virtual-kubelet
|
||||
</h2>
|
||||
</span>
|
||||
|
||||
<p class="cli-description">
|
||||
{{ $description }}
|
||||
</p>
|
||||
|
||||
<div class="cli-example">
|
||||
<span class="dollar">$</span> virtual-kubelet <span class="flags">flags</span>
|
||||
</div>
|
||||
|
||||
<div class="cli-flags">
|
||||
<h3>
|
||||
Flags
|
||||
</h3>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>
|
||||
Flag
|
||||
</th>
|
||||
<th>
|
||||
Description
|
||||
</th>
|
||||
<th>
|
||||
Default
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{{ range $flags }}
|
||||
<tr>
|
||||
<td class="flag">
|
||||
{{ .name }}{{ with .arg }} <span class="arg">{{ . }}</span>{{ end }}
|
||||
</td>
|
||||
<td>
|
||||
{{ .description | markdownify }}
|
||||
</td>
|
||||
<td>
|
||||
{{ with .default }}
|
||||
<code>{{ . }}</code>
|
||||
{{ end }}
|
||||
</td>
|
||||
</tr>
|
||||
{{ end }}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
Reference in New Issue
Block a user