Refactor build to cake's new node based vitepress theme package

Author: josbeir

bin/check-links.js .github/check-links.jsbin/check-links.js renamed to .github/check-links.js

@@ -57,7 +57,7 @@ jobs:
         uses: actions/checkout@v6
 
       - name: Check TOC links exist
-        run: node bin/check-toc-links.js
+        run: node .github/check-toc-links.js
 
   markdown-lint:
     name: Lint Markdown
@@ -121,4 +121,4 @@ jobs:
 
       - name: Check internal links
         if: steps.changed-files.outputs.files != ''
-        run: node bin/check-links.js --baseline .github/linkchecker-baseline.json ${{ steps.changed-files.outputs.files }}
+        run: node .github/check-links.js --baseline .github/linkchecker-baseline.json ${{ steps.changed-files.outputs.files }}

bin/check-toc-links.js .github/check-toc-links.jsbin/check-toc-links.js renamed to .github/check-toc-links.js

@@ -5,6 +5,10 @@
 .vitepress/.temp
 /node_modules/
 .temp/
+docs/public/favicon/
+docs/public/fonts/
+docs/public/icons/
+docs/public/logo.svg
 
 # IDE and editor specific files #
 #################################

.github/workflows/docs-validation.yml

@@ -0,0 +1,73 @@
+import baseConfig from '@cakephp/docs-skeleton/config'
+
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const toc_en = require("./toc_en.json");
+const toc_ja = require("./toc_ja.json");
+
+const versions = {
+  text: "5.x",
+  items: [
+    { text: "5.x (latest)", link: "https://book.cakephp.org/5.x/", target: '_self' },
+    { text: "4.x", link: "https://book.cakephp.org/4.x/", target: '_self' },
+    { text: "3.x", link: "https://book.cakephp.org/3.x/", target: '_self' },
+    { text: "2.x", link: "https://book.cakephp.org/2.x/", target: '_self' },
+    { text: "Next releases", items: [
+      { text: "5.next", link: "https://book.cakephp.org/5.next/", target: '_self' },
+      { text: "6.x", link: "https://book.cakephp.org/6.x/", target: '_self' },
+    ]},
+  ],
+};
+
+// This file contains overrides for .vitepress/config.js
+export default {
+  extends: baseConfig,
+  base: "/5.x/",
+  rewrites: {
+    "en/:slug*": ":slug*",
+  },
+  sitemap: {
+    hostname: "https://book.cakephp.org/5.x/",
+  },
+  themeConfig: {
+    socialLinks: [
+      { icon: "github", link: "https://github.com/cakephp/cakephp" },
+    ],
+    editLink: {
+      pattern: "https://github.com/cakephp/docs/edit/5.x/docs/:path",
+      text: "Edit this page on GitHub",
+    },
+    sidebar: toc_en,
+    nav: [
+      { text: "Guide", link: "/intro" },
+      { text: "API", link: "https://api.cakephp.org/" },
+      { text: "Documentation", link: "/" },
+      { ...versions },
+    ],
+  },
+  substitutions: {
+    '|phpversion|': { value: '8.5', format: 'bold' },
+    '|minphpversion|': { value: '8.2', format: 'italic' },
+    '|cakeversion|': '5.3',
+    '|cakefullversion|': 'CakePHP 5',
+  },
+  locales: {
+    root: {
+      label: "English",
+      lang: "en",
+    },
+    ja: {
+      label: "Japanese",
+      lang: "ja",
+      themeConfig: {
+        nav: [
+          { text: "ガイド", link: "/ja/intro" },
+          { text: "API", link: "https://api.cakephp.org/" },
+          { text: "ドキュメント", link: "/ja/" },
+          { ...versions },
+        ],
+        sidebar: toc_ja,
+      },
+    },
+  },
+};

.gitignore

@@ -0,0 +1 @@
+export { default } from '@cakephp/docs-skeleton'

.vitepress/config.js

@@ -16,40 +16,29 @@ files, marked up with Markdown formatting.
 
 ## Local Development
 
-For working with the documentation markdown files locally, use the provided development server script:
+Install dependencies, then start the VitePress development server:
 
 ```bash
-./bin/dev-server.sh
+npm install
+npm run docs:dev
 ```
 
-This script will:
-- Set up a clean `.temp` working directory
-- Clone the VitePress skeleton repository
-- Sync your documentation files
-- Install dependencies
-- Start a local development server with hot-reload
+The documentation will be available at `http://localhost:5173` with hot-reload enabled.
 
-The documentation will be available at `http://localhost:5173`
-
-### Development Server Options
+### Other Commands
 
 ```bash
-# Start on a custom port
-./bin/dev-server.sh --port 3000
+# Build the static site
+npm run docs:build
 
-# Adjust docs sync interval (default: 1 second)
-./bin/dev-server.sh --sync-interval 2
+# Preview the production build locally
+npm run docs:preview
 ```
 
 ### Prerequisites
 
-The development server requires:
-- `git` - Version control
 - `node` - JavaScript runtime
 - `npm` - Package manager
-- `rsync` - File synchronization
-
-Press `Ctrl+C` to stop the development server.
 
 ## Build the Documentation with Docker