feat(docs): add docusaurus workspace, initial setup of docs

2025-11-13 08:13:49 +10:00 · 2022-03-08 23:54:00 +01:00
parent a131bb3652
commit dc4aa0b496
16 changed files with 6184 additions and 177 deletions
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@ -0,0 +1,120 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Reactive Resume',
+  tagline: 'A free and open source resume builder.',
+  url: 'https://docs.rxresu.me',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon.ico',
+  organizationName: 'AmruthPillai',
+  projectName: 'Reactive-Resume',
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        blog: false,
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: require.resolve('./sidebars.js'),
+          editUrl: 'https://github.com/AmruthPillai/Reactive-Resume/tree/main/docs',
+        },
+        sitemap: {
+          changefreq: 'weekly',
+          priority: 0.5,
+        },
+        theme: {
+          customCss: require.resolve('./styles/custom.css'),
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      navbar: {
+        title: 'Reactive Resume',
+        logo: {
+          alt: 'Reactive Resume',
+          src: 'img/logo.svg',
+        },
+        items: [
+          {
+            href: 'https://github.com/AmruthPillai/Reactive-Resume',
+            position: 'right',
+            label: 'GitHub',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Sections',
+            items: [
+              {
+                label: 'Documentation',
+                to: '/docs/intro',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'GitHub',
+                href: 'https://github.com/AmruthPillai/Reactive-Resume',
+              },
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/AmruthPillai',
+              },
+            ],
+          },
+          {
+            title: 'Support',
+            items: [
+              {
+                label: 'Translate',
+                href: 'https://translate.rxresu.me',
+              },
+              {
+                label: 'Donate',
+                href: 'https://buymeacoffee.com/AmruthPillai',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} Amruth Pillai. Licensed under MIT. Built with Docusaurus.`,
+      },
+      metadata: [
+        {
+          name: 'keywords',
+          content: [
+            'reactive resume',
+            'resume builder',
+            'free resumes',
+            'resume templates',
+            'free resume templates',
+            'open source resume builder',
+            'resume builder source code',
+          ].join(', '),
+        },
+      ],
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
+};
+
+module.exports = config;