Skip to content

Commit 50d345e

Browse files
bbengfortbbengfort
committed
Base Documentation with Hugo
1 parent 0362d32 commit 50d345e

22 files changed

+218
-0
lines changed

‎.gitmodules

Whitespace-only changes.

‎docs/.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Generated files by hugo
2+
/public/
3+
/resources/_gen/
4+
/assets/jsconfig.json
5+
hugo_stats.json
6+
7+
# Executable may be added to repository
8+
hugo.exe
9+
hugo.darwin
10+
hugo.linux
11+
12+
# Temporary lock file while building
13+
/.hugo_build.lock

‎docs/archetypes/default.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
date = '{{ .Date }}'
3+
draft = true
4+
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
5+
+++

‎docs/assets/.gitkeep

Whitespace-only changes.

‎docs/content/en/_index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
date: 2024-11-25T13:31:01-06:00
3+
draft: false
4+
title: Honu Database Documentation
5+
---
6+
7+
Welcome to the documentation for the Honu Database. More will be coming soon!

‎docs/data/.gitkeep

Whitespace-only changes.

‎docs/hugo.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
baseURL: https://honudb.dev
2+
title: Honu DB
3+
4+
module:
5+
hugoVersion:
6+
extended: true
7+
min: 0.110.0

‎docs/i18n/.gitkeep

Whitespace-only changes.

‎docs/layouts/_default/baseof.html

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE html>
2+
<html lang="{{ with site.LanguageCode }}{{ . }}{{ else }}en-us{{ end }}">
3+
<head>
4+
{{ block "head" . }}{{ partial "site-head.html" .}}{{ end }}
5+
</head>
6+
<body>
7+
8+
{{ block "header" . }}{{ partial "site-header.html" .}}{{ end }}
9+
10+
<main>
11+
{{ block "main" . }}{{ end }}
12+
</main>
13+
14+
{{ block "footer" . }}{{ partial "site-footer.html" . }}{{ end }}
15+
{{ block "scripts" . }}{{ partial "site-scripts.html" . }}{{ end }}
16+
{{ block "appcode" . }}{{ end }}
17+
18+
</body>
19+
</html>

‎docs/layouts/_default/list.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{ define "main" }}
2+
{{ range .Pages }}
3+
<article>
4+
<h2>{{ .Title }}</h2>
5+
{{ .Content }}
6+
</article>
7+
{{ end }}
8+
{{ end }}

‎docs/layouts/_default/rss.xml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{{- $pctx := . -}}
2+
{{- if .IsHome -}}{{ $pctx = .Site }}{{- end -}}
3+
{{- $pages := slice -}}
4+
{{- if or $.IsHome $.IsSection -}}
5+
{{- $pages = (where (where $pctx.RegularPages ".Section" "blog") "Kind" "page") -}}
6+
{{- else -}}
7+
{{- $pages = (where (where $pctx.Pages ".Section" "blog") "Kind" "page") -}}
8+
{{- end -}}
9+
{{- $limit := .Site.Config.Services.RSS.Limit -}}
10+
{{- if ge $limit 1 -}}
11+
{{- $pages = $pages | first $limit -}}
12+
{{- end -}}
13+
{{- printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>" | safeHTML }}
14+
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
15+
<channel>
16+
<title>{{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
17+
<link>{{ .Permalink }}</link>
18+
<description>Recent content {{ if ne .Title .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }}</description>
19+
<generator>Hugo -- gohugo.io</generator>
20+
<language>{{ site.Language.LanguageCode }}</language>{{ with .Site.Author.email }}
21+
<managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }}
22+
<webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }}
23+
<copyright>{{ replace . "{year}" now.Year | markdownify }}</copyright>{{end}}{{ if not .Date.IsZero }}
24+
<lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }}
25+
{{- with .OutputFormats.Get "RSS" -}}
26+
{{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
27+
{{- end -}}
28+
{{ range $pages }}
29+
<item>
30+
<title>{{ .Title }}</title>
31+
<link>{{ .Permalink }}</link>
32+
<pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
33+
{{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
34+
<guid>{{ .Permalink }}</guid>
35+
<description>{{ .Summary | html }}</description>
36+
</item>
37+
{{ end }}
38+
</channel>
39+
</rss>

‎docs/layouts/_default/single.html

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{{ define "title" }}
2+
{{ .Title }} &ndash; {{ .Site.Title }}
3+
{{ end }}
4+
5+
{{ define "main" }}
6+
<div>
7+
{{ .Content }}
8+
</div>
9+
{{ end }}

‎docs/layouts/humans.txt

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{{ $data := index site.Data site.Language.Lang }}
2+
{{- with $data.team.team -}}
3+
/* TEAM */
4+
5+
{{ range .team_member }}
6+
{{ .designation }}: {{ .name }}
7+
Bio: {{ .bioLink | absURL }}
8+
{{ end }}
9+
{{ end }}
10+
11+
/* SITE */
12+
13+
Last update: {{ now.Format "2006-01-02" }}
14+
Site name: {{ .Site.Title }}
15+
URL: {{ .Site.BaseURL }}
16+
CMS: Hugo
17+
Host: GitHub Pages
18+
Language: {{ range $i, $l := site.Languages }}{{ if $i }}, {{ end }}{{ .LanguageName }}{{ end }}
19+
Doctype: HTML5
20+
Standards: HTML5, CSS3, Open Graph protocol, Schema.org
21+
Components: Hugo, FontAwesome, Flowbite, HighlightJS, Lunr.js
22+
IDE: VSCode, Atom, Vim, MacVim
23+
24+
[Credit for this page: http://humanstxt.org/]

‎docs/layouts/partials/alerts.html

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{{ $data := index site.Data site.Language.Lang }}
2+
3+
{{ with $data.alerts.notice }}
4+
{{ if .enable }}
5+
{{ $expires := sub (time .expires).Unix now.Unix }}
6+
{{ if gt $expires 0}}
7+
<div class="bg-[#192E5B] border-b-2 border-[#72A2C0] text-white py-5" role="alert">
8+
<p class="text-lg text-center">
9+
{{ .notice | markdownify }}
10+
{{ if .action }}
11+
<span class="px-2">|</span>
12+
<a href="{{ .action.link }}" target="_blank" class="underline hover:text-slate-400">
13+
{{ .action.text }}
14+
</a>
15+
{{ end }}
16+
</p>
17+
</div>
18+
{{ end }}
19+
{{ end }}
20+
{{ end }}

‎docs/layouts/partials/site-footer.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<footer class="relative mt-40 md:mt-56 bg-[#192E5B]">
2+
{{ $data := index site.Data site.Language.Lang }}
3+
</footer>

‎docs/layouts/partials/site-head.html

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<meta charset="UTF-8">
2+
<title>{{ block "title" . }}{{ .Site.Title }}{{ with .Params.Title }} | {{ . }}{{ end }}{{ end }}</title>
3+
<base href="{{ .Site.BaseURL }}" target="_self">
4+
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
8+
{{- $title := .Params.Title -}}{{ if not .Params.Title }}{{ $title = .Site.Title }}{{ end }}
9+
{{- $description := .Params.description -}}{{ if not .Params.description }}{{ $description = .Site.Params.description }}{{ end }}
10+
{{- $author := .Params.author -}}{{ if not .Params.author }}{{ $author = .Site.Params.author }}{{ end }}
11+
{{- $keywords := .Params.keywords -}}{{ if not .Params.keywords }}{{ $keywords = .Site.Params.keywords }}{{ end }}
12+
{{- $image := .Params.Image -}}{{ if not .Params.Image }}{{ $image = .Site.Params.image }}{{ end }}
13+
14+
{{ "<!-- Document Metadata -->" | safeHTML }}
15+
{{ with $author }}<meta name="author" content="{{ . }}">{{ end }}
16+
{{ with $description }}<meta name="description" content="{{ . }}">{{ end }}
17+
{{ with $keywords }}<meta name="keywords" content="{{ . }}">{{ end }}
18+
<link type="text/plain" rel="author" href="{{ "humans.txt" | absURL }}" />
19+
20+
{{ "<!-- OpenGraph Metadata -->" | safeHTML }}
21+
{{ with $title }}<meta property="og:title" content="{{ . }}" />{{ end }}
22+
{{ with $description }}<meta property="og:description" content="{{ . }}" />{{ end }}
23+
{{ with $image }}<meta property="og:image" content="{{ . | absURL }}" />{{ end }}
24+
{{ if $title }}<meta property="og:url" content="{{ .Permalink }}" />{{ end }}
25+
{{ if $title }}<meta property="og:type" content="website" />{{ end }}
26+
27+
{{ "<!-- Twitter Metadata -->" | safeHTML }}
28+
{{ with $title }}<meta name="twitter:title" content="{{ . }}" />{{ end }}
29+
{{ if $title }}<meta name="twitter:card" content="summary">{{ end }}
30+
{{ with $description }}<meta name="twitter:description" content="{{ . }}" />{{ end }}
31+
{{ with $image }}<meta name="twitter:image" content="{{ . | absURL }}" />{{ end }}
32+
33+
{{ "<!-- Favicon and Iconography -->" | safeHTML }}
34+
<link rel="shortcut icon" href="{{ `img/favicon.png` | absURL }}" type="image/x-icon">
35+
<link rel="icon" href="{{ `img/favicon.png` | absURL }}" type="image/x-icon">
36+
37+
{{ "<!-- RSS Feeds -->" | safeHTML }}
38+
<link rel="alternate" type="application/rss+xml" href="{{.Site.BaseURL }}/index.xml" title="Recent Rotations of the Rotational Labs Blog">
39+
40+
{{/* TODO: Site Manifest and Apple Icons */}}
41+
42+
{{ "<!-- Fonts -->" | safeHTML }}
43+
44+
{{"<!-- Main Stylesheet -->"|safeHTML}}
45+
46+
{{- if .Site.Params.googleAnalytics -}}
47+
{{ "<!-- Google Analytics -->" | safeHTML }}
48+
<script src="https://www.googletagmanager.com/gtag/js?id={{ .Site.Params.googleAnalytics }}" defer></script>
49+
<script type="module">
50+
window.dataLayer = window.dataLayer || [];
51+
function gtag() { dataLayer.push(arguments); }
52+
gtag('js', new Date());
53+
gtag('config', '{{ .Site.Params.googleAnalytics }}');
54+
</script>
55+
{{ end }}

‎docs/layouts/partials/site-header.html

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{{ partial "alerts.html" }}
2+
3+
<div class="">
4+
</div>

‎docs/layouts/partials/site-scripts.html

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Application Scripts -->

‎docs/layouts/robots.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
User-agent: *
2+
Allow: /
3+
4+
Sitemap: {{ "sitemap.xml" | absURL }}

‎docs/serialization-benchmark.png

-15.9 KB
Binary file not shown.

‎docs/static/.gitkeep

Whitespace-only changes.

‎docs/themes/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)