feat: ✨ enhance documentation structure and add redirect to intro page

Author: gracefullight

.gitignore

@@ -35,3 +35,9 @@ yarn-error.log*
 
 packages/*/dist/
 packages/*/dist/*
+
+# Ignore everything inside docs/ by default (generated content)
+apps/docs/docs/*
+apps/docs/docs/intro.md
+# But keep the placeholder file
+!apps/docs/docs/.gitkeep

apps/docs/docs/.gitignore

@@ -1,3 +1,38 @@
-# Docusaurus Plugins
+# @gracefullight/docusaurus-plugins
 
-Documentation for the plugins in this repository.
+This monorepo contains a collection of plugins for [Docusaurus](https://docusaurus.io/) to enhance your documentation website. The following plugins are included:
+
+- [@gracefullight/docusaurus-plugin-baidu-analytics](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-baidu-analytics)
+- [@gracefullight/docusaurus-plugin-channelio](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-channelio)
+- [@gracefullight/docusaurus-plugin-chatra](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-chatra)
+- [@gracefullight/docusaurus-plugin-cloudflare-analytics](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-cloudflare-analytics)
+- [@gracefullight/docusaurus-plugin-gitter](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-gitter)
+- [@gracefullight/docusaurus-plugin-google-adsense](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-google-adsense)
+- [@gracefullight/docusaurus-plugin-intercom](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-intercom)
+- [@gracefullight/docusaurus-plugin-meta-pixel](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-meta-pixel)
+- [@gracefullight/docusaurus-plugin-microsoft-clarity](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-microsoft-clarity)
+- [@gracefullight/docusaurus-plugin-naver-analytics](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-naver-analytics)
+- [@gracefullight/docusaurus-plugin-sentry](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-sentry)
+- [@gracefullight/docusaurus-plugin-tailwind](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-tailwind)
+- [@gracefullight/docusaurus-plugin-vercel-analytics](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-vercel-analytics)
+- [@gracefullight/docusaurus-plugin-yandex-metrica](https://www.npmjs.com/package/@gracefullight/docusaurus-plugin-yandex-metrica)
+
+## Installation
+
+You can install these plugins via pnpm:
+
+```bash
+pnpm add @gracefullight/docusaurus-plugin-${PLUGIN_NAME}
+```
+
+## Usage
+
+To use these plugins, you will need to configure them in your Docusaurus `docusaurus.config.js` file. Please refer to the individual plugin's README for specific configuration instructions.
+
+## Contributing
+
+Contributions are welcome. If you find a bug or want to suggest a new feature, please open an issue or a pull request. To contribute a new plugin, you can use the command `pnpm gen plugin`.
+
+## License
+
+This repository is licensed under the [MIT License](#license).

apps/docs/docs/.gitkeep

@@ -1,5 +1,20 @@
+import type { ThemeConfig } from "@docusaurus/preset-classic";
 import type { Config } from "@docusaurus/types";
 
+const themeConfig: ThemeConfig = {
+  navbar: {
+    items: [
+      {
+        "aria-label": "GitHub repository",
+        className: "header-github-link",
+        href: "https://github.com/gracefullight/docusaurus-plugins",
+        position: "right",
+      },
+    ],
+    title: "docusaurus-plugins",
+  },
+};
+
 const config: Config = {
   baseUrl: "/docusaurus-plugins/",
   favicon: "img/favicon.ico",
@@ -12,12 +27,14 @@ const config: Config = {
       {
         blog: false,
         docs: {
+          routeBasePath: "/",
           sidebarPath: "./sidebars.ts",
         },
       },
     ],
   ],
   projectName: "docusaurus-plugins",
+  themeConfig,
   title: "docusaurus-plugins",
   url: "https://gracefullight.github.io",
 };

apps/docs/docs/intro.md

@@ -19,8 +19,7 @@
   "private": true,
   "scripts": {
     "build": "pnpm prepare-docs && docusaurus build",
-    "prepare-docs": "tsx ./scripts/prepare-docs.ts",
-    "start": "pnpm prepare-docs && docusaurus start"
-  },
-  "type": "module"
+    "dev": "pnpm prepare-docs && docusaurus start",
+    "prepare-docs": "tsx ./scripts/prepare-docs.ts"
+  }
 }

apps/docs/docusaurus.config.ts

@@ -1,21 +1,54 @@
-import { access, copyFile, mkdir, readdir, rm } from "node:fs/promises";
+import {
+  access,
+  copyFile,
+  mkdir,
+  readdir,
+  readFile,
+  rm,
+  writeFile,
+} from "node:fs/promises";
 import { join } from "node:path";
 
-const root = join(process.cwd(), "..", "..", "packages");
-const outDir = join(process.cwd(), "docs", "plugins");
+async function main() {
+  const monorepoRoot = join(process.cwd(), "..", "..");
+  const packagesRoot = join(monorepoRoot, "packages");
+  const outDir = join(process.cwd(), "docs", "plugins");
 
-await rm(outDir, { force: true, recursive: true });
-await mkdir(outDir, { recursive: true });
+  await rm(outDir, { force: true, recursive: true });
+  await mkdir(outDir, { recursive: true });
 
-const packages = await readdir(root, { withFileTypes: true });
-
-for (const dir of packages) {
-  if (!dir.isDirectory() || dir.name === "tsconfig") continue;
-  const readme = join(root, dir.name, "README.md");
+  // Copy the monorepo README as the docs intro page
+  const repoReadme = join(monorepoRoot, "README.md");
+  const introDoc = join(process.cwd(), "docs", "intro.md");
   try {
-    await access(readme);
-    await copyFile(readme, join(outDir, `${dir.name}.md`));
+    await access(repoReadme);
+    const raw = await readFile(repoReadme, "utf8");
+    // Rewrite repo-relative links that would 404 on the docs site
+    const rewritten = raw.replace(
+      /\((?:\.\/)?LICENSE(?:\.md)?\)/g,
+      "(#license)",
+    );
+    await writeFile(introDoc, rewritten, "utf8");
   } catch {
-    /* ignore */
+    // ignore if the root README does not exist
+  }
+
+  // Copy each package README under docs/plugins
+  const packages = await readdir(packagesRoot, { withFileTypes: true });
+
+  for (const dir of packages) {
+    if (!dir.isDirectory() || dir.name === "tsconfig") continue;
+    const readme = join(packagesRoot, dir.name, "README.md");
+    try {
+      await access(readme);
+      await copyFile(readme, join(outDir, `${dir.name}.md`));
+    } catch {
+      /* ignore */
+    }
   }
 }
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

apps/docs/package.json

@@ -0,0 +1,7 @@
+import { Redirect } from "@docusaurus/router";
+import useBaseUrl from "@docusaurus/useBaseUrl";
+
+export default function Home() {
+  const to = useBaseUrl("/intro");
+  return <Redirect to={to} />;
+}