docs: setup docusaurus for documentation (#848)

* docs: setup docusaurus for documentation * docs: setup tailwind content for docusaurus * chore: ensure tailwindcss is installed so pages deploy works * docs: add cname to point to docs * ci: override format checking for pnpm-lock in gen-docs folder * docs(gen-docs): readme for docusaurus * chore(gen-docs): remove unnecessary image files * docs: remove installation instructions (moved to docs) * ci: rename docusaurus workflows to a more explicit name * style(gen-docs): custom color for links * docs: add more doc pages * style: gradient menu link bg, proper jellyseerr font & footer bg color * docs: fix proper link to relative pages * style: tab-items also now uses the proper jellyseerr colors * style: use prismTheme shadesOfPurple for codeblock/syntax highlighting * docs: fix broken links * docs: fix broken links * docs: fix broken anchors * chore(gen-docs): local search bar * style(gen-docs): tab colors * docs: reverse-proxy documentation * style(gen-docs): jellyseerr-like cards * docs: rename baremetal to build from source * docs: nixpkg version check component * docs: conditionally render override package derivation block and admonitions * docs: users section of the documentation
2024-06-30 03:37:56 +05:00
parent bdee340530
commit ce02f61c0d
62 changed files with 13421 additions and 1389 deletions
--- a/gen-docs/docusaurus.config.ts
+++ b/gen-docs/docusaurus.config.ts
@@ -0,0 +1,115 @@
+import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
+import { themes as prismThemes } from 'prism-react-renderer';
+
+const config: Config = {
+  title: 'Jellyseerr',
+  tagline: 'One Stop Solution for all your media request needs',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://docs.jellyseerr.dev',
+  baseUrl: '/',
+
+  organizationName: 'Fallenbagel',
+  projectName: 'Jellyseerr',
+  deploymentBranch: 'docs',
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          sidebarPath: './sidebars.ts',
+          routeBasePath: '/',
+          path: '../docs',
+          editUrl:
+            'https://github.com/Fallenbagel/jellyseerr/edit/develop/docs/',
+        },
+        blog: false,
+        pages: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themes: [
+    [
+      '@easyops-cn/docusaurus-search-local',
+      /**  @type {import("@easyops-cn/docusaurus-search-local").PluginOptions}  */
+      {
+        hashed: true,
+        indexBlog: false,
+        docsDir: '../docs',
+        docsRouteBasePath: '/',
+        explicitSearchResultPath: true,
+      },
+    ],
+  ],
+
+  themeConfig: {
+    image: 'img/docusaurus-social-card.jpg',
+    colorMode: {
+      defaultMode: 'dark',
+      disableSwitch: true,
+      respectPrefersColorScheme: false,
+    },
+    navbar: {
+      logo: {
+        alt: 'Jellyseerr',
+        src: 'img/logo.svg',
+      },
+      items: [
+        {
+          href: 'https://github.com/Fallenbagel/jellyseerr',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Docs',
+          items: [
+            {
+              label: 'Documentation',
+              to: '/',
+            },
+          ],
+        },
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'Discord',
+              href: 'https://discord.gg/ckbvBtDJgC',
+            },
+            {
+              label: 'Github Discussions',
+              href: 'https://github.com/fallenbagel/jellyseerr/discussions',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} Jellyseerr. Built with Docusaurus.`,
+    },
+    prism: {
+      theme: prismThemes.shadesOfPurple,
+      darkTheme: prismThemes.shadesOfPurple,
+      additionalLanguages: ['bash', 'powershell', 'yaml', 'nix', 'nginx'],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;