docs

docs/website/docusaurus.config.js

@@ -0,0 +1,81 @@
+// @ts-check
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: "scholarr",
+  tagline: "Self-hosted scholar tracking docs",
+  favicon: "img/favicon.ico",
+
+  url: "https://justinzeus.github.io",
+  baseUrl: "/scholarr/",
+
+  organizationName: "JustinZeus",
+  projectName: "scholarr",
+
+  onBrokenLinks: "throw",
+  onBrokenMarkdownLinks: "warn",
+
+  i18n: {
+    defaultLocale: "en",
+    locales: ["en"],
+  },
+
+  presets: [
+    [
+      "classic",
+      {
+        docs: {
+          path: "..",
+          exclude: ["website/**", "README.md"],
+          routeBasePath: "/",
+          sidebarPath: require.resolve("./sidebars.js"),
+          editUrl: "https://github.com/JustinZeus/scholarr/tree/main/",
+        },
+        blog: false,
+        theme: {
+          customCss: require.resolve("./src/css/custom.css"),
+        },
+      },
+    ],
+  ],
+
+  themeConfig: {
+    navbar: {
+      title: "scholarr",
+      items: [
+        {
+          type: "docSidebar",
+          sidebarId: "docsSidebar",
+          position: "left",
+          label: "Docs",
+        },
+        {
+          href: "https://github.com/JustinZeus/scholarr",
+          label: "GitHub",
+          position: "right",
+        },
+      ],
+    },
+    footer: {
+      style: "dark",
+      links: [
+        {
+          title: "Docs",
+          items: [{ label: "Index", to: "/" }],
+        },
+        {
+          title: "Community",
+          items: [
+            {
+              label: "GitHub",
+              href: "https://github.com/JustinZeus/scholarr",
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} scholarr.`,
+    },
+  },
+};
+
+module.exports = config;

docs/website/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "scholarr-docs",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "start": "docusaurus start",
+    "build": "docusaurus build",
+    "serve": "docusaurus serve"
+  },
+  "dependencies": {
+    "@docusaurus/core": "3.9.2",
+    "@docusaurus/preset-classic": "3.9.2",
+    "clsx": "^2.1.1",
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  }
+}

docs/website/sidebars.js

@@ -0,0 +1,40 @@
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  docsSidebar: [
+    "index",
+    {
+      type: "category",
+      label: "Users",
+      items: ["user/overview", "user/getting-started"],
+    },
+    {
+      type: "category",
+      label: "Operations",
+      items: [
+        "operations/overview",
+        "operations/scrape-safety-runbook",
+        "operations/database-runbook",
+        "operations/migration-checklist",
+      ],
+    },
+    {
+      type: "category",
+      label: "Developers",
+      items: [
+        "developer/overview",
+        "developer/documentation-standards",
+        "developer/local-development",
+        "developer/architecture",
+        "developer/contributing",
+        "developer/frontend-theme-inventory",
+      ],
+    },
+    {
+      type: "category",
+      label: "Reference",
+      items: ["reference/overview", "reference/api-contract", "reference/environment"],
+    },
+  ],
+};
+
+module.exports = sidebars;

docs/website/src/css/custom.css

@@ -0,0 +1,9 @@
+:root {
+  --ifm-color-primary: #2a6b4e;
+  --ifm-color-primary-dark: #255f46;
+  --ifm-color-primary-darker: #225942;
+  --ifm-color-primary-darkest: #1c4936;
+  --ifm-color-primary-light: #2f7756;
+  --ifm-color-primary-lighter: #327d5a;
+  --ifm-color-primary-lightest: #3b946b;
+}