create static docs site with module options

This commit is contained in:
Bryton Hall 2022-08-28 15:22:43 -04:00 committed by GitHub
parent e3127e8c14
commit e75b801a31
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 448 additions and 19 deletions

View file

@ -0,0 +1,40 @@
{{ $name := index . "name" }}
{{ $option := index . "option" }}
{{ $repo := index . "repo" }}
{{ $path := path.Join (after 2 (split (index $option.declarations 0) "/")) }}
<details id="{{ $name }}">
<summary>
<pre>{{ $name }}</pre>
</summary>
<table>
<tr>
<td>Description</td>
<td>{{ $option.description }}</td>
</tr>
<tr>
<td>Type</td>
<td><pre>{{ $option.type }}</pre></td>
</tr>
<tr>
<td>Default</td>
<td>{{ partial "highlight" $option.default }}</td>
</tr>
{{ with $option.example }}
<tr>
<td>Example</td>
<td>{{ partial "highlight" . }}</td>
</tr>
{{ end }}
<tr>
<td>Declared in</td>
<td><a href="{{ $repo }}/blob/main/{{ $path }}" target="_blank">{{ $path }}</a></td>
</tr>
</table>
</details>