docs progress part 4

- add favicon - add title to source code and theme icon - add publish shell script
go-resty · Dec 29, 2024 · d337cc0 · d337cc0
1 parent 0efd03e
commit d337cc0
Show file tree

Hide file tree

Showing 16 changed files with 67 additions and 3 deletions.
diff --git a/content/docs/upgrading-to-v3.md b/content/docs/upgrading-to-v3.md
@@ -23,7 +23,7 @@ I made necessary breaking changes to improve Resty and open up future growth pos
 
 * All the Resty errors start with `resty: ...` prefix and sub feature errors contain feature name in them, e.g., `resty: digest: ...`
 
-### Behavior
+#### Behavior
 
 * Set Content length is not applicable for `io.Reader` flow.
 * By default, payload is not supported in HTTP verb DELETE. Use [Client.AllowMethodDeletePayload]({{% param Resty.V3.GoDocLinkPrefix %}}Client.AllowMethodDeletePayload) or [Request.AllowMethodDeletePayload]({{% param Resty.V3.GoDocLinkPrefix %}}Request.AllowMethodDeletePayload).

diff --git a/hugo.yaml b/hugo.yaml
@@ -23,9 +23,12 @@ markup:
   tableOfContents:
     startLevel: 1
     endLevel: 4
+    # ordered: false
   highlight:
     style: base16-snazzy
 
+cleanDestinationDir: true
+
 # menu:
 #   before:
 #     - name: Home

diff --git a/layouts/partials/docs/inject/menu-after.html b/layouts/partials/docs/inject/menu-after.html
@@ -1,9 +1,9 @@
 <div class="r-footer">
     <div class="r-info-box">
-        <a href="https://github.com/go-resty/resty" rel="external" target="_blank">
+        <a href="https://github.com/go-resty/resty" rel="external" target="_blank" title="Resty Source Code">
             <img src="/svg/github.svg" alt="Resty Source Code" class="book-icon r-icon" />
         </a>
-        <a id="colorSchemeToggle" onclick="toggleDarkMode()">
+        <a id="colorSchemeToggle" onclick="toggleDarkMode()" title="Light or Dark">
             <img id="darkModeIcon" src="/svg/color-scheme.svg" class="book-icon r-icon" />
         </a>
     </div>

diff --git a/publish.sh b/publish.sh
@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# Versions
+# 1.0.0 Initial script
+
+echo 'Starting resty docs publish process ...'
+
+echo 'Cleanup ...'
+yes | rm -rf public/
+yes | rm -rf resources/_gen/
+
+echo 'Run hugo publish ...'
+hugo --gc --minify
+
+echo 'Copy required files into public/'
+cp -rp resty/public/ public/
+
+echo 'Delete .DS_Store files ...'
+find public/ -type f -name '.DS_Store' -delete
+
+echo 'Publish process completed.'
diff --git a/resty/favicon/apple-touch-icon.png b/resty/favicon/apple-touch-icon.png
diff --git a/resty/favicon/favicon-96x96.png b/resty/favicon/favicon-96x96.png
diff --git a/resty/favicon/favicon.ico b/resty/favicon/favicon.ico
diff --git a/resty/favicon/favicon.png b/resty/favicon/favicon.png
diff --git a/resty/favicon/favicon.svg b/resty/favicon/favicon.svg
diff --git a/resty/favicon/site.webmanifest b/resty/favicon/site.webmanifest
@@ -0,0 +1,21 @@
+{
+  "name": "MyWebSite",
+  "short_name": "MySite",
+  "icons": [
+    {
+      "src": "/web-app-manifest-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png",
+      "purpose": "maskable"
+    },
+    {
+      "src": "/web-app-manifest-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png",
+      "purpose": "maskable"
+    }
+  ],
+  "theme_color": "#ffffff",
+  "background_color": "#ffffff",
+  "display": "standalone"
+}
diff --git a/resty/favicon/web-app-manifest-192x192.png b/resty/favicon/web-app-manifest-192x192.png
diff --git a/resty/favicon/web-app-manifest-512x512.png b/resty/favicon/web-app-manifest-512x512.png
diff --git a/resty/public/robots.txt b/resty/public/robots.txt
@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /
diff --git a/resty/public/v3/go-get.html b/resty/public/v3/go-get.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta name="go-import" content="resty.dev/v3 git https://github.com/go-resty/resty" />
+        <meta name="go-source" content="resty.dev/v3 https://github.com/go-resty/resty/tree/v3 https://github.com/go-resty/resty/tree/v3{/dir} https://github.com/go-resty/resty/blob/v3{/dir}/{file}#L{line}" />
+        <meta http-equiv="refresh" content="0; url=https://pkg.go.dev/resty.dev/v3" />
+    </head>
+    <body>
+        Nothing to see here. Redirecting to <a href="https://pkg.go.dev/resty.dev/v3">godoc</a>...
+    </body>
+</html>
diff --git a/static/favicon.png b/static/favicon.png