docs

elringus · Dec 26, 2023 · 4c11e60 · 4c11e60
1 parent 9224524
commit 4c11e60
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 6 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -22,6 +22,7 @@ export default defineConfig({
         logoLink: "https://imgit.dev",
         socialLinks: [{ icon: "github", link: "https://github.com/elringus/imgit" }],
         externalLinkIcon: true,
+        search: { provider: "local" },
         lastUpdated: { text: "Updated", formatOptions: { dateStyle: "medium" } },
         sidebarMenuLabel: "Menu",
         darkModeSwitchLabel: "Appearance",
@@ -42,7 +43,7 @@ export default defineConfig({
             text: "Edit this page on GitHub"
         },
         sidebar: {
-            "/": [
+            "/guide/": [
                 {
                     text: "Guide",
                     collapsed: true,

diff --git a/docs/index.md b/docs/index.md
@@ -7,7 +7,7 @@ titleTemplate: Convert media links to optimized HTML
 hero:
   name: imgit
   text: Convert media links to optimized HTML
-  tagline: Images, video and YouTube: fetch, encode, scale, lazyload – for best UX and [Web Vitals](https://web.dev/vitals).
+  tagline: Images, video and YouTube&#58; fetch, encode, scale, lazyload – for best UX and <a href="https://web.dev/vitals" target="_blank">Web Vitals</a>.
   actions:
     - theme: brand
       text: Get Started
@@ -28,7 +28,7 @@ features:
     details: Encodes to the modern AV1/AVIF format compressing by up to 90% without noticeable quality loss. Supports GPU acceleration.
   - icon: ♻️
     title: Polyglot
-    details: Works with most known media formats: JPEG, PNG, APNG, SVG, GIF, WEBP, WEBM, MP4, AVI, MOV, MKV, BMP, TIFF, TGA and even PSD.
+    details: Works with most known media formats&#58; JPEG, PNG, APNG, SVG, GIF, WEBP, WEBM, MP4, AVI, MOV, MKV, BMP, TIFF, TGA and even PSD.
   - icon: 🌊
     title: Smooth
     details: Generates tiny blurred covers from the source content to be beautifully crossfaded into HD originals once lazy-loaded.
@@ -63,4 +63,11 @@ features:
     --vp-home-hero-image-filter: blur(68px);
   }
 }
+
+/* Disable navbar blur effect when not scrolled */
+.VPNavBar { transition: background-color 0.3s ease-out; }
+.VPNavBar.top { background: transparent !important;  }
+.dark .VPNavBar.top { background: transparent !important; }
+.VPNav::after { transition: opacity 0.3s ease-out; }
+.VPNav.top::after { opacity: 0; }
 </style>
diff --git a/docs/package.json b/docs/package.json
@@ -1,9 +1,9 @@
 {
     "type": "module",
     "scripts": {
-        "dev": "vitepress dev docs",
-        "build": "vitepress build docs",
-        "preview": "vitepress preview docs"
+        "dev": "vitepress dev",
+        "build": "vitepress build",
+        "preview": "vitepress preview"
     },
     "devDependencies": {
         "typescript": "^5.3.3",

diff --git a/docs/public/imgit/covers.json b/docs/public/imgit/covers.json
@@ -0,0 +1 @@
+{}
diff --git a/docs/public/imgit/probes.json b/docs/public/imgit/probes.json
@@ -0,0 +1 @@
+{}
diff --git a/docs/public/imgit/sizes.json b/docs/public/imgit/sizes.json
@@ -0,0 +1 @@
+{}
diff --git a/docs/public/imgit/specs.json b/docs/public/imgit/specs.json
@@ -0,0 +1 @@
+{}
diff --git a/docs/public/imgit/youtube.json b/docs/public/imgit/youtube.json
@@ -0,0 +1 @@
+{}