docs: migrate to the shared @coreui/astro-docs engine

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
       # yarn.lock is gitignored in this repo, so there is no lockfile to pin
       # against or to key a cache on — install resolves from package.json.
-      - run: yarn install
+      - run: yarn install --ignore-engines
       - run: yarn lib:build
       - run: yarn lib:test
 
@@ -40,5 +40,5 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 22.x
-      - run: yarn install
+      - run: yarn install --ignore-engines
       - run: yarn lint

.gitignore

@@ -2,7 +2,6 @@
 coverage/
 dist/
 node_modules/
-public/
 yarn.lock
 
 # IDEs and editors
@@ -30,4 +29,5 @@ Thumbs.db
 *.swp
 *.vi
 *.zip
-*~
+*~
+.gstack/

CLAUDE.md

@@ -12,7 +12,7 @@ This is a **Lerna monorepo** with the following key packages:
 - `packages/coreui-react/` - Main React components library (TypeScript)
 - `packages/coreui-icons-react/` - Icon components for React
 - `packages/coreui-react-chartjs/` - Chart.js integration for React
-- `packages/docs/` - Gatsby-based documentation site
+- `packages/docs/` - Astro-based documentation site
 
 ## Development Commands
 

eslint.config.mjs

@@ -4,6 +4,7 @@ import eslintPluginUnicorn from 'eslint-plugin-unicorn'
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
 import eslintPluginReact from 'eslint-plugin-react'
 import eslintPluginReactHooks from 'eslint-plugin-react-hooks'
+import eslintPluginUnusedImports from 'eslint-plugin-unused-imports'
 import globals from 'globals'
 import typescriptEslint from 'typescript-eslint'
 
@@ -19,6 +20,7 @@ export default typescriptEslint.config(
     ],
     plugins: {
       'react-hooks': eslintPluginReactHooks,
+      'unused-imports': eslintPluginUnusedImports,
     },
     files: ['packages/**/src/**/*.{js,ts,tsx}'],
     languageOptions: {
@@ -43,6 +45,12 @@ export default typescriptEslint.config(
     },
     rules: {
       ...eslintPluginReactHooks.configs.recommended.rules,
+      '@typescript-eslint/no-unused-vars': 'off',
+      'unused-imports/no-unused-imports': 'error',
+      'unused-imports/no-unused-vars': [
+        'error',
+        { vars: 'all', varsIgnorePattern: '^_', args: 'after-used', argsIgnorePattern: '^_' },
+      ],
       'no-console': 'off',
       'no-debugger': 'off',
       // the library compiles with the classic JSX transform (tsconfig "jsx": "react"),
@@ -103,7 +111,12 @@ export default typescriptEslint.config(
   {
     files: ['packages/docs/**'],
     rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
       '@typescript-eslint/no-var-requires': 'off',
+      'react/no-unescaped-entities': 'off',
+      'react-hooks/refs': 'off',
+      'react-hooks/set-state-in-effect': 'off',
+      'unicorn/consistent-function-scoping': 'off',
       'unicorn/prefer-module': 'off',
     },
   },

package.json

@@ -8,7 +8,7 @@
     "charts:test": "lerna run --scope \"@coreui/react-chartjs\" test --stream",
     "charts:test:update": "lerna run --scope \"@coreui/react-chartjs\" test:update --stream",
     "docs:api": "lerna run --scope \"@coreui/react-docs\" api --stream",
-    "docs:dev": "lerna run --scope \"@coreui/react-docs\" develop --stream",
+    "docs:dev": "lerna run --scope \"@coreui/react-docs\" dev --stream",
     "docs:build": "lerna run --scope \"@coreui/react-docs\" build --stream",
     "docs:clean": "lerna run --scope \"@coreui/react-docs\" clean",
     "icons:build": "lerna run --scope \"@coreui/icons-react\" build --stream",
@@ -22,25 +22,18 @@
     "test:update": "npm-run-all charts:test:update icons:test:update lib:test:update"
   },
   "devDependencies": {
-    "@typescript-eslint/parser": "^8.61.0",
+    "@typescript-eslint/parser": "^8.62.0",
     "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-prettier": "^5.5.6",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-unicorn": "^62.0.0",
+    "eslint-plugin-unused-imports": "^4.4.1",
     "globals": "^16.5.0",
     "lerna": "^9.0.7",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.8.4",
-    "typescript-eslint": "^8.61.0"
-  },
-  "overrides": {
-    "gatsby-remark-external-links": {
-      "unist-util-find": "1.0.2"
-    }
-  },
-  "resolutions": {
-    "**/gatsby-remark-external-links/unist-util-find": "1.0.2"
+    "prettier": "^3.9.1",
+    "typescript-eslint": "^8.62.0"
   }
 }

packages/coreui-react/package.json

@@ -64,7 +64,7 @@
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-transition-group": "^4.4.5",
-    "rollup": "^4.62.0",
+    "rollup": "^4.62.2",
     "ts-jest": "^29.4.11",
     "tslib": "^2.8.1",
     "typescript": "^5.9.3"

packages/coreui-react/rollup.config.mjs

@@ -21,7 +21,7 @@ const plugins = [
     },
   }),
   commonjs({
-    include: ['../../node_modules/**'],
+    include: [/node_modules/],
   }),
 ]
 

packages/docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+.astro/

packages/docs/api.config.mjs

@@ -0,0 +1,16 @@
+// Components to document. The @coreui/astro-docs-api-generator CLI (`yarn api`) runs the
+// React extractor (react-docgen-typescript) and writes one <Name>.api.json per component
+// into outDir — the shared ApiData shape the engine's <Api> renders. createApiConfig
+// scans each root for source components (`C*.tsx`, minus declarations/specs/tests).
+import { createApiConfig } from '@coreui/astro-docs-api-generator/config'
+
+export default createApiConfig({
+  framework: 'react',
+  configUrl: import.meta.url,
+  importPackage: '@coreui/react',
+  roots: [
+    '../coreui-react/src/components',
+    '../coreui-react-chartjs/src',
+    '../coreui-icons-react/src',
+  ],
+})

packages/docs/astro.config.mjs

@@ -0,0 +1,45 @@
+import { defineConfig } from 'astro/config'
+import react from '@astrojs/react'
+import mdx from '@astrojs/mdx'
+import { coreuiDocs } from '@coreui/astro-docs/integration'
+import { fileURLToPath } from 'node:url'
+import { createRequire } from 'node:module'
+
+const require = createRequire(import.meta.url)
+
+// Live-src: point @coreui/react and its icon/chart submodules at their source in this
+// repo. The icon data set (@coreui/icons) and chart.js stay published deps.
+const reactSrc = fileURLToPath(new URL('../coreui-react/src/index.ts', import.meta.url))
+const iconsReactSrc = fileURLToPath(new URL('../coreui-icons-react/src/index.ts', import.meta.url))
+const reactChartjsSrc = fileURLToPath(new URL('../coreui-react-chartjs/src/index.ts', import.meta.url))
+// @coreui/chartjs ships CJS `main` + a separate esm build; point imports at the esm
+// so the named `customTooltips` export resolves under SSR.
+const chartjsEsm = require.resolve('@coreui/chartjs/dist/js/coreui-chartjs.esm.js')
+// Depth-independent imports for example + generated API data, so docs pages can
+// move freely without rewriting relative paths.
+const examples = fileURLToPath(new URL('./src/examples', import.meta.url))
+const api = fileURLToPath(new URL('./src/api', import.meta.url))
+
+export default defineConfig({
+  // Publish URL (site + base) is config-driven: coreuiDocs() reads `seo.url` from
+  // src/data/config.yml and sets Astro's `site` + `base` from it, so the versioned
+  // (…/react/docs/5.x) and current (…/react/docs) builds differ by one config value.
+  // coreuiDocs() detects the edition + wires styling; it returns an array (incl.
+  // global component auto-import), so spread it — and place it before mdx().
+  integrations: [react(), ...coreuiDocs(), mdx()],
+  vite: {
+    resolve: {
+      // Array form: the icons-react `/src/index` subpath import must match before the
+      // bare `@coreui/icons-react` entry.
+      alias: [
+        { find: '@coreui/icons-react/src/index', replacement: iconsReactSrc },
+        { find: '@coreui/icons-react', replacement: iconsReactSrc },
+        { find: '@coreui/react-chartjs', replacement: reactChartjsSrc },
+        { find: '@coreui/chartjs', replacement: chartjsEsm },
+        { find: '@coreui/react', replacement: reactSrc },
+        { find: '@examples', replacement: examples },
+        { find: '@api', replacement: api },
+      ],
+    },
+  },
+})