Refactor build to cake's new node based vitepress theme package (#8262)

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

* clarify readme

Author: josbeir

.github/.markdownlint-cli2.jsonc

@@ -75,7 +75,7 @@
     "no-emphasis-as-heading": false
   },
   "customRules": [
-    "./markdownlint-rules/no-space-after-fence.js"
+    "./markdownlint-rules/no-space-after-fence.cjs"
   ],
   "ignores": [
     "node_modules/**"

bin/check-links.js .github/check-links.cjsbin/check-links.js renamed to .github/check-links.cjs

@@ -51,15 +51,15 @@ function checkLink(link, docsDir, lang) {
  * e.g., "toc_en.json" -> "en"
  */
 function getLangFromTocFile(tocFile) {
-  const match = tocFile.match(/^toc_(\w+)\.json$/);
+  const match = tocFile.match(/toc_(\w+)\.json$/);
   return match ? match[1] : null;
 }
 
 /**
  * Main validation function
  */
 function validateTocFiles() {
-  const tocFiles = fs.readdirSync(".").filter((f) => f.match(/^toc_.*\.json$/));
+  const tocFiles = fs.readdirSync(".vitepress").filter((f) => f.match(/^toc_.*\.json$/)).map((f) => `.vitepress/${f}`);
 
   if (tocFiles.length === 0) {
     console.error("No toc_*.json files found");

bin/check-toc-links.js .github/check-toc-links.cjsbin/check-toc-links.js renamed to .github/check-toc-links.cjs

@@ -40,7 +40,7 @@ jobs:
 
       - name: Validate JSON syntax
         run: |
-          for file in toc_*.json; do
+          for file in .vitepress/toc_*.json; do
             if ! jq empty "$file" 2>/dev/null; then
               echo "Invalid JSON: $file"
               exit 1
@@ -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.cjs
 
   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.cjs --baseline .github/linkchecker-baseline.json ${{ steps.changed-files.outputs.files }}

…rkdownlint-rules/no-space-after-fence.js …kdownlint-rules/no-space-after-fence.cjs.github/markdownlint-rules/no-space-after-fence.js renamed to .github/markdownlint-rules/no-space-after-fence.cjs .github/markdownlint-rules/no-space-after-fence.js renamed to .github/markdownlint-rules/no-space-after-fence.cjs

@@ -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'