about summary refs log tree commit diff stats
path: root/frontend/templates
diff options
context:
space:
mode:
authorAlan Pearce2024-06-08 20:31:47 +0200
committerAlan Pearce2024-06-08 20:42:48 +0200
commitd40c0e188a7fe1b36887f59c4a9958faa81b3d44 (patch)
treeb6c168adcc3336dd0f6de4b1cbb7bf671f212f53 /frontend/templates
parentef6c98da84c2327e0a0003fb3b1b64a5d1e2d550 (diff)
downloadsearchix-d40c0e188a7fe1b36887f59c4a9958faa81b3d44.tar.lz
searchix-d40c0e188a7fe1b36887f59c4a9958faa81b3d44.tar.zst
searchix-d40c0e188a7fe1b36887f59c4a9958faa81b3d44.zip
feat: add detail pages for packages/options
Diffstat (limited to 'frontend/templates')
-rw-r--r--frontend/templates/blocks/option.gotmpl48
-rw-r--r--frontend/templates/blocks/package.gotmpl69
2 files changed, 117 insertions, 0 deletions
diff --git a/frontend/templates/blocks/option.gotmpl b/frontend/templates/blocks/option.gotmpl
new file mode 100644
index 0000000..2248708
--- /dev/null
+++ b/frontend/templates/blocks/option.gotmpl
@@ -0,0 +1,48 @@
+{{- define "main" }}
+  {{- with .Document }}
+    <h2>{{ .Name }}</h2>
+    {{ markdown .Description }}
+    <dl>
+      {{- with .Type }}
+        <dt>Type</dt>
+        <dd><code>{{ . }}</code></dd>
+      {{- end }}
+      {{- with .Default }}
+        {{- if or .Text .Markdown }}
+          <dt>Default</dt>
+          <dd>
+            {{- if .Markdown }}
+              {{ markdown .Markdown }}
+            {{- else }}
+              <pre><code>{{ .Text }}</code></pre>
+            {{- end }}
+          </dd>
+        {{- end }}
+      {{- end }}
+      {{- with .Example }}
+        {{- if or .Text .Markdown }}
+          <dt>Example</dt>
+          <dd>
+            {{- if .Markdown }}
+              {{ markdown .Markdown }}
+            {{- else }}
+              <pre><code>{{ .Text }}</code></pre>
+            {{- end }}
+          </dd>
+        {{- end }}
+      {{- end }}
+      {{- with .RelatedPackages }}
+        <dt>Related Packages</dt>
+        <dd>{{ . }}</dd>
+      {{- end }}
+      {{- with .Declarations }}
+        <dt>Declared</dt>
+        {{- range . }}
+          <dd>
+            <a href="{{ .URL }}">{{ .Name }}</a>
+          </dd>
+        {{- end }}
+      {{- end }}
+    </dl>
+  {{- end }}
+{{- end }}
diff --git a/frontend/templates/blocks/package.gotmpl b/frontend/templates/blocks/package.gotmpl
new file mode 100644
index 0000000..a42a8b1
--- /dev/null
+++ b/frontend/templates/blocks/package.gotmpl
@@ -0,0 +1,69 @@
+{{- define "main" }}
+  {{- with .Document }}
+    <h2>
+      {{- if .Broken }}
+        <del>{{ .Attribute }}</del>
+      {{- else }}
+        {{ .Attribute }}
+      {{- end }}
+    </h2>
+    {{- if .LongDescription }}
+      {{ markdown .LongDescription }}
+    {{- else }}
+      <p>{{ .Description }}</p>
+    {{- end }}
+    <dl>
+      {{- with .MainProgram }}
+        <dt>Main Program</dt>
+        <dd>
+          <code>{{ . }}</code>
+        </dd>
+      {{- end }}
+      {{- with .Homepages }}
+        <dt>Homepage</dt>
+        <dd>
+          {{- range . }}
+            <a href="{{ . }}">{{ . }}</a>
+          {{- end }}
+        </dd>
+      {{- end }}
+      {{- with .Version }}
+        <dt>Version</dt>
+        <dd>{{ . }}</dd>
+      {{- end }}
+      {{- with .Licenses }}
+        <dt>License</dt>
+        <dd>
+          {{- range . }}
+            {{- if .URL }}
+              <a href="{{ .URL }}">{{ or .FullName .Name }}</a>
+            {{- else }}
+              {{ or .FullName .Name }}
+            {{- end }}
+            {{- with .AppendixURL }}
+              <a href="{{ . }}">Appendix</a>
+            {{- end }}
+          {{- end }}
+        </dd>
+      {{- end }}
+      {{- with .Maintainers }}
+        <dt>Maintainer{{ if gt (len .) 1 }}s{{ end }}</dt>
+        <dd>
+          {{- range . }}
+            {{- if .Github }}
+              <a href="https://github.com/{{ .Github }}">{{ .Name }}</a>
+            {{- else }}
+              {{ .Name }}
+            {{- end }}
+          {{- end }}
+        </dd>
+      {{- end }}
+      {{- with .Definition }}
+        <dt>Defined</dt>
+        <dd>
+          <a href="{{ . }}">Source</a>
+        </dd>
+      {{- end }}
+    </dl>
+  {{- end }}
+{{- end }}