migrate frontend to docusaurus (#9014)

* delete loads of really important stuff that we definitely need * v basic MVP smoosh docusaurus PoC into repo * TODO * delete more really important stuff * TODO * tidyup: use run-s * don't redirect images used in frontend to raster proxy * fix routing * preserve the /endpoint link * delete the blog (for now) I would quite like to re-add this at some point but its not really the top priority thing right now * content edits * appease the lint gods * update danger rules * remove placeholder * cypress tests * dockerhub --> ghcr * Revert "dockerhub --> ghcr" This reverts commit ef74cbb26b. * downgrade lockfile format * implement defs/BASE_URL * fix e2e build * actually fix cypress tests * always run cypress tests on build * this never worked * add command for docusaurus:clear * delete more code we don't need any more * update ESLint/prettier config * delete unsused exports * documentation updates * delete a fairly large chunk of our dependency tree * allow base_url as build arg to Dockerfile * fixup dockerfile * work out base url at runtime if not set doing this at image build time is not the right approach * remove gatsby monorepo from closebot * rename HomepageFeatures to homepage-features
2023-06-17 10:59:07 +01:00
parent 67d935492d
commit 50ea7068a8
92 changed files with 22922 additions and 31531 deletions
--- a/frontend/docusaurus.config.cjs
+++ b/frontend/docusaurus.config.cjs
@@ -0,0 +1,122 @@
+const lightCodeTheme = require('prism-react-renderer/themes/github')
+const darkCodeTheme = require('prism-react-renderer/themes/dracula')
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Shields.io',
+  tagline: 'Concise, consistent, and legible badges',
+  url: 'https://shields.io',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon.ico',
+  organizationName: 'badges',
+  projectName: 'shields',
+
+  themes: [
+    [
+      require.resolve('@easyops-cn/docusaurus-search-local'),
+      /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
+      ({
+        hashed: true,
+        indexPages: true,
+      }),
+    ],
+  ],
+
+  presets: [
+    [
+      'docusaurus-preset-openapi',
+      /** @type {import('docusaurus-preset-openapi').Options} */
+      ({
+        docs: {
+          sidebarPath: require.resolve('./sidebars.cjs'),
+          editUrl: 'https://github.com/badges/shields/',
+        },
+        blog: {
+          showReadingTime: true,
+          editUrl: 'https://github.com/badges/shields/',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+        api: {
+          path: 'categories',
+          routeBasePath: 'badges',
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('docusaurus-preset-openapi').ThemeConfig} */
+    ({
+      languageTabs: [],
+      navbar: {
+        title: 'Shields.io',
+        logo: {
+          alt: 'Shields Logo',
+          src: 'img/logo.png',
+        },
+        items: [
+          { to: '/badges', label: 'Badges', position: 'left' },
+          { to: '/community', label: 'Community', position: 'left' },
+          {
+            href: 'https://github.com/badges/shields',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'GitHub',
+                href: 'https://github.com/badges/shields',
+              },
+              {
+                label: 'Open Collective',
+                href: 'https://opencollective.com/shields',
+              },
+              {
+                label: 'Discord',
+                href: 'https://discord.gg/HjJCwm5',
+              },
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/shields_io',
+              },
+              {
+                label: 'Awesome Badges',
+                href: 'https://github.com/badges/awesome-badges',
+              },
+            ],
+          },
+          {
+            title: 'Stats',
+            items: [
+              {
+                label: 'Service Status',
+                href: 'https://stats.uptimerobot.com/PjXogHB5p',
+              },
+              {
+                label: 'Metrics dashboard',
+                href: 'https://metrics.shields.io/',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} Shields.io. Built with Docusaurus.`,
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
+}
+
+module.exports = config