Added documentation

2025-12-09 21:12:57 +08:00 · 2025-04-22 18:07:42 +12:00
parent cd70b3550f
commit 5d0f4b5b4b
46 changed files with 19310 additions and 0 deletions
--- a/docs/docusaurus.config.ts
+++ b/docs/docusaurus.config.ts
@@ -0,0 +1,127 @@
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
+
+const config: Config = {
+  title: 'MCP Database Server',
+  tagline: 'Fastest way to interact with your Database such as SQL Server, SQLite and PostgreSQL',
+  favicon: 'img/favicon.ico',
+
+  // Set the production url of your site here
+  url: 'https://executeautomation.github.io/',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: '/mcp-database-server',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: 'executeautomation', // Usually your GitHub org/user name.
+  projectName: 'mcp-database-server', // Usually your repo name.
+
+  onBrokenLinks: 'ignore',
+  onBrokenMarkdownLinks: 'warn',
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+  trailingSlash: false,
+  deploymentBranch: 'gh-pages',
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          sidebarPath: './sidebars.ts',
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl:
+            'https://github.com/executeautomation/mcp-database-server/tree/main/docs/',
+        },
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    // Replace with your project's social card
+    image: 'img/EA-Icon.svg',
+    navbar: {
+      title: 'MCP Database Server',
+      logo: {
+        alt: 'MCP Database Server',
+        src: 'img/EA-Icon.svg',
+      },
+      items: [
+        {
+          type: 'docSidebar',
+          sidebarId: 'tutorialSidebar',
+          position: 'left',
+          label: 'Documentation',
+        },
+        {
+          href: 'https://github.com/executeautomation/mcp-database-server',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Docs',
+          items: [
+            {
+              label: 'Getting Started',
+              to: '/docs/getting-started',
+            },
+            {
+              label: 'SQLite Setup',
+              to: '/docs/sqlite-setup',
+            },
+            {
+              label: 'SQL Server Setup',
+              to: '/docs/sql-server-setup',
+            },
+            {
+              label: 'PostgreSQL Setup',
+              to: '/docs/postgresql-setup',
+            },
+          ],
+        },
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'Youtube',
+              href: 'https://youtube.com/executeautomation',
+            },
+            {
+              label: 'Udemy',
+              href: 'https://www.udemy.com/user/karthik-kk',
+            },
+            {
+              label: 'X',
+              href: 'http://x.com/ExecuteAuto',
+            },
+          ],
+        }
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} ExecuteAutomation Pvt Ltd.`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;