update docs backend

fixes issue with OpenGraph tags

docs/favicon-formats.ts

@@ -1,80 +1,80 @@
 interface Favicon {
-  rel: string | null;
-  dimensions: [number, number];
-  image_format: string;
-  prefix: string;
+    rel: string | null;
+    dimensions: [number, number];
+    image_format: string;
+    prefix: string;
 }
 
 export default [
-  { dimensions: [64, 64], image_format: 'ico', prefix: 'favicon', rel: null },
-  { dimensions: [16, 16], image_format: 'png', prefix: 'favicon', rel: 'icon' },
-  { dimensions: [32, 32], image_format: 'png', prefix: 'favicon', rel: 'icon' },
-  { dimensions: [64, 64], image_format: 'png', prefix: 'favicon', rel: 'icon' },
-  { dimensions: [96, 96], image_format: 'png', prefix: 'favicon', rel: 'icon' },
-  { dimensions: [180, 180], image_format: 'png', prefix: 'favicon', rel: 'icon' },
-  {
-    dimensions: [57, 57],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [60, 60],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [72, 72],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [76, 76],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [114, 114],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [120, 120],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [144, 144],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [152, 152],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [167, 167],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  {
-    dimensions: [180, 180],
-    image_format: 'png',
-    prefix: 'apple-touch-icon',
-    rel: 'apple-touch-icon',
-  },
-  { dimensions: [70, 70], image_format: 'png', prefix: 'mstile', rel: null },
-  { dimensions: [270, 270], image_format: 'png', prefix: 'mstile', rel: null },
-  { dimensions: [310, 310], image_format: 'png', prefix: 'mstile', rel: null },
-  { dimensions: [310, 150], image_format: 'png', prefix: 'mstile', rel: null },
-  { dimensions: [196, 196], image_format: 'png', prefix: 'favicon', rel: 'shortcut icon' },
+    { dimensions: [48, 48], image_format: "ico", prefix: "favicon", rel: null },
+    { dimensions: [16, 16], image_format: "png", prefix: "favicon", rel: "icon" },
+    { dimensions: [32, 32], image_format: "png", prefix: "favicon", rel: "icon" },
+    { dimensions: [64, 64], image_format: "png", prefix: "favicon", rel: "icon" },
+    { dimensions: [96, 96], image_format: "png", prefix: "favicon", rel: "icon" },
+    { dimensions: [180, 180], image_format: "png", prefix: "favicon", rel: "icon" },
+    {
+        dimensions: [57, 57],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [60, 60],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [72, 72],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [76, 76],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [114, 114],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [120, 120],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [144, 144],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [152, 152],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [167, 167],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    {
+        dimensions: [180, 180],
+        image_format: "png",
+        prefix: "apple-touch-icon",
+        rel: "apple-touch-icon",
+    },
+    { dimensions: [70, 70], image_format: "png", prefix: "mstile", rel: null },
+    { dimensions: [270, 270], image_format: "png", prefix: "mstile", rel: null },
+    { dimensions: [310, 310], image_format: "png", prefix: "mstile", rel: null },
+    { dimensions: [310, 150], image_format: "png", prefix: "mstile", rel: null },
+    { dimensions: [196, 196], image_format: "png", prefix: "favicon", rel: "shortcut icon" },
 ] as Favicon[];

docs/next.config.mjs

@@ -0,0 +1,35 @@
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import withNextra from "nextra";
+
+function copyChangelog() {
+    const dir = path.dirname(fileURLToPath(import.meta.url));
+    const src = path.resolve(dir, "..", "CHANGELOG.md");
+    const data = fs.readFileSync(src);
+    const replaced = data.toString().replace("# Changelog\n\n", "");
+    const dst = path.resolve(dir, "pages", "changelog.mdx");
+    fs.writeFileSync(dst, replaced);
+}
+
+copyChangelog();
+
+/**
+ * @type {import('nextra').NextraConfig}
+ */
+const nextraConfig = {
+    theme: "nextra-theme-docs",
+    themeConfig: "./theme.config.tsx",
+};
+
+/**
+ * @type {import('next').NextConfig}
+ */
+const config = {
+    images: {
+        unoptimized: true,
+    },
+    output: "export",
+};
+
+export default withNextra(nextraConfig)(config);

docs/package.json

@@ -12,8 +12,8 @@
   "license": "BSD-3-Clause-Clear",
   "dependencies": {
     "next": "^14.1.1",
-    "nextra": "^2.13.4",
-    "nextra-theme-docs": "^2.13.4",
+    "nextra": "3.0.0-alpha.24",
+    "nextra-theme-docs": "3.0.0-alpha.24",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

docs/pages/_meta.tsx

@@ -0,0 +1,38 @@
+export default {
+    index: { title: "Introduction", theme: { breadcrumb: false } },
+    "---": {
+        type: "separator",
+    },
+    installation: "Installation",
+    configuration: "Configuration",
+    platforms: "Platforms",
+    plugins: "Plugins",
+    documentation: {
+        title: "Documentation",
+        type: "menu",
+        items: {
+            installation: {
+                title: "Installation",
+                href: "/installation",
+            },
+            configuration: {
+                title: "Configuration",
+                href: "/configuration",
+            },
+            plugins: {
+                title: "Plugins",
+                href: "/plugins",
+            },
+            changelog: {
+                title: "Changelog",
+                href: "/changelog",
+            },
+        },
+    },
+    demo: {
+        title: "Demo",
+        type: "page",
+        href: "https://demo.hyperglass.dev",
+        newWindow: true,
+    },
+};

docs/pages/configuration/_meta.tsx

@@ -0,0 +1,7 @@
+export default {
+    overview: "Overview",
+    config: "Config File",
+    devices: "Devices File",
+    directives: "Directives File",
+    examples: "Examples",
+};

docs/pages/configuration/config/_meta.tsx

@@ -0,0 +1,8 @@
+export default {
+    "api-docs": "API Docs",
+    caching: "Caching",
+    logging: "Logging & Webhooks",
+    messages: "Messages",
+    "structured-output": "Structured Output",
+    "web-ui": "Web UI",
+};

docs/pages/configuration/config/web-ui.mdx

@@ -1,4 +1,4 @@
-import { Callout } from "nextra-theme-docs";
+import { Callout } from "nextra/components";
 import { Color } from "~/components/color";
 
 ## Web UI

docs/pages/configuration/devices.mdx

@@ -1,4 +1,4 @@
-import { Callout } from "nextra-theme-docs";
+import { Callout } from "nextra/components";
 import { SupportedPlatforms } from "~/components/platforms";
 import { DocsButton } from "~/components/docs-button";
 
@@ -76,7 +76,10 @@ devices:
           password: your password
 ```
 
-### <DocsButton href="/configuration/directives.mdx"/> With Directives
+<h3 className="_font-semibold _tracking-tight _text-slate-900 dark:_text-slate-100 _mt-8 _text-2xl">
+    {" "}
+    <DocsButton href="/configuration/directives" /> With Directives
+</h3>
 
 In this example, an additional directive `cisco-show-lldp-neighbors` is added to the built-in directives.
 
@@ -92,7 +95,10 @@ devices:
           - cisco-show-lldp-neighbors
 ```
 
-### <DocsButton href="/configuration/directives.mdx"/> Disable Built-in Directives
+<h3 className="_font-semibold _tracking-tight _text-slate-900 dark:_text-slate-100 _mt-8 _text-2xl">
+    {" "}
+    <DocsButton href="/configuration/directives" /> Disable Built-in Directives
+</h3>
 
 In this example, _only_ the `cisco-show-lldp-neighbors` directive will be available. Built-in directives are disabled.
 
@@ -109,7 +115,10 @@ devices:
           - cisco-show-lldp-neighbors
 ```
 
-### <DocsButton href="/configuration/directives.mdx"/> Enable Specifc Built-in Directives
+<h3 className="_font-semibold _tracking-tight _text-slate-900 dark:_text-slate-100 _mt-8 _text-2xl">
+    {" "}
+    <DocsButton href="/configuration/directives" /> Enable Specifc Built-in Directives
+</h3>
 
 In this example, only specified built-in directives are made available.