docs: add supported devices page

silitics · May 28, 2024 · ba787e6 · ba787e6
1 parent b6e2f66
commit ba787e6
Show file tree

Hide file tree

Showing 7 changed files with 849 additions and 113 deletions.
diff --git a/www/docusaurus.config.ts b/www/docusaurus.config.ts
@@ -1,9 +1,10 @@
-import type {Config} from '@docusaurus/types';
-import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from "@docusaurus/types"
+import type * as Preset from "@docusaurus/preset-classic"
 
 const config: Config = {
   title: "Rugpi",
-  tagline: "An open-source platform empowering you to build innovative products based on Raspberry Pi.",
+  tagline:
+    "An open-source platform empowering you to build innovative products based on Raspberry Pi.",
   url: "https://oss.silitics.com/",
   baseUrl: "/rugpi/",
 
@@ -24,10 +25,10 @@ const config: Config = {
   presets: [
     [
       "classic",
-      ({
+      {
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
-          lastVersion: '0.6',
+          lastVersion: "0.6",
           editUrl: "https://github.com/silitics/rugpi/tree/main/www/",
         },
         blog: {
@@ -37,118 +38,135 @@ const config: Config = {
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
         },
-      }) satisfies Preset.Options,
+      } satisfies Preset.Options,
     ],
   ],
 
-  themeConfig:
-    ({
-      colorMode: {
-        defaultMode: "dark",
-        disableSwitch: true,
-        respectPrefersColorScheme: false,
-      },
-
-      announcementBar: {
-        // id: "release",
-        content: `
+  themeConfig: {
+    colorMode: {
+      defaultMode: "dark",
+      disableSwitch: true,
+      respectPrefersColorScheme: false,
+    },
+
+    announcementBar: {
+      // id: "release",
+      content: `
           We are excited to announce the release of Rugpi version 0.6! 🎉
           Read the <a href="/rugpi/blog/releases/0.6">release blog post</a>.
         `,
-        backgroundColor: "#bdddfb",
-        // backgroundColor: "#bdddfb",
-        // textColor: "#000000",
-        isCloseable: false,
+      backgroundColor: "#bdddfb",
+      // backgroundColor: "#bdddfb",
+      // textColor: "#000000",
+      isCloseable: false,
+    },
+    navbar: {
+      title: "Rugpi",
+      logo: {
+        alt: "Rugpi Logo",
+        src: "img/logo.svg",
       },
-      navbar: {
-        title: "Rugpi",
-        logo: {
-          alt: "Rugpi Logo",
-          src: "img/logo.svg",
+      items: [
+        {
+          type: "doc",
+          docId: "getting-started",
+          position: "left",
+          label: "Docs",
         },
-        items: [
-          {
-            type: "doc",
-            docId: "getting-started",
-            position: "left",
-            label: "Docs",
-          },
-          { to: "/blog", label: "Blog", position: "left" },
-          {
-            type: 'docsVersionDropdown',
-            position: 'right',
-            // dropdownItemsAfter: [{to: '/versions', label: 'All versions'}],
-            dropdownActiveClassDisabled: true,
-          },
-          {
-            href: "https://github.com/silitics/rugpi",
-            position: "right",
-            className: "header-github-link",
-            "aria-label": "GitHub",
-          },
-        ],
-      },
-      footer: {
-        style: "dark",
-        links: [
-          {
-            title: "Docs",
-            items: [
-              {
-                label: "Getting Started",
-                to: "/docs/getting-started",
-              },
-              {
-                label: "User Guide",
-                to: "/docs/guide",
-              },
-            ],
-          },
-          {
-            title: "Community",
-            items: [
-              {
-                label: "GitHub",
-                href: "https://github.com/silitics/rugpi",
-              },
-              {
-                label: "Discussions",
-                href: "https://github.com/silitics/rugpi/discussions",
-              },
-            ],
-          },
-          {
-            title: "More",
-            items: [
-              {
-                label: "Blog",
-                to: "/blog",
-              },
-            ],
-          },
-          {
-            title: "Legal",
-            items: [
-              {
-                // German and EU law require us to have a privacy policy.
-                label: "Privacy Policy",
-                href: "https://silitics.com/privacy-policy"
-              },
-              {
-                // German law requires us to have an Impressum.
-                label: "Impressum",
-                href: "https://silitics.com/impressum",
-              },
-            ],
-          },
-        ],
-        copyright: `<div>Made with ❤️ for OSS</div><div>Copyright © ${new Date().getFullYear()} <a href="https://silitics.com">Silitics GmbH</a></div><div>Built with Docusaurus</div><div style="margin-top: 0.5em"><small>Raspberry Pi is a trademark of Raspberry Pi Ltd</small></div>`,
-      },
-      prism: {
-        theme: require("prism-react-renderer").themes.vsDark,
-        additionalLanguages: ["rust", "toml"],
-      },
-    }) satisfies Preset.ThemeConfig,
+        {
+          to: "/devices",
+          label: "Supported Devices",
+          position: "left",
+        },
+        { to: "/blog", label: "Blog", position: "left" },
+        {
+          type: "docsVersionDropdown",
+          position: "right",
+          // dropdownItemsAfter: [{to: '/versions', label: 'All versions'}],
+          dropdownActiveClassDisabled: true,
+        },
+        {
+          href: "https://github.com/silitics/rugpi",
+          position: "right",
+          className: "header-github-link",
+          "aria-label": "GitHub",
+        },
+      ],
+    },
+    footer: {
+      style: "dark",
+      links: [
+        {
+          title: "Docs",
+          items: [
+            {
+              label: "Getting Started",
+              to: "/docs/getting-started",
+            },
+            {
+              label: "User Guide",
+              to: "/docs/guide",
+            },
+          ],
+        },
+        {
+          title: "Community",
+          items: [
+            {
+              label: "GitHub",
+              href: "https://github.com/silitics/rugpi",
+            },
+            {
+              label: "Discussions",
+              href: "https://github.com/silitics/rugpi/discussions",
+            },
+          ],
+        },
+        {
+          title: "More",
+          items: [
+            {
+              label: "Blog",
+              to: "/blog",
+            },
+          ],
+        },
+        {
+          title: "Legal",
+          items: [
+            {
+              // German and EU law require us to have a privacy policy.
+              label: "Privacy Policy",
+              href: "https://silitics.com/privacy-policy",
+            },
+            {
+              // German law requires us to have an Impressum.
+              label: "Impressum",
+              href: "https://silitics.com/impressum",
+            },
+          ],
+        },
+      ],
+      copyright: `<div>Made with ❤️ for OSS</div><div>Copyright © ${new Date().getFullYear()} <a href="https://silitics.com">Silitics GmbH</a></div><div>Built with Docusaurus</div><div style="margin-top: 0.5em"><small>Raspberry Pi is a trademark of Raspberry Pi Ltd</small></div>`,
+    },
+    prism: {
+      theme: require("prism-react-renderer").themes.vsDark,
+      additionalLanguages: ["rust", "toml"],
+    },
+  } satisfies Preset.ThemeConfig,
+
+  plugins: [
+    async function tailwind(context, options) {
+      return {
+        name: "docusaurus-tailwindcss",
+        configurePostCss(postcssOptions) {
+          postcssOptions.plugins.push(require("tailwindcss"));
+          postcssOptions.plugins.push(require("autoprefixer"));
+          return postcssOptions;
+        },
+      };
+    },
+  ]
 }
 
-export default config;
+export default config