Sync docs from v8 main repo

.eleventy.js

@@ -86,6 +86,7 @@ md.renderer.rules.table_column_open = (tokens, idx, options, env, self) => {
 };
 
 module.exports = (eleventyConfig) => {
+  eleventyConfig.setUseGitIgnore(false);
   eleventyConfig.addPlugin(pluginRss);
   eleventyConfig.addPlugin(pluginSyntaxHighlight, {
     init({ Prism }) {
@@ -105,6 +106,7 @@ module.exports = (eleventyConfig) => {
   });
 
   eleventyConfig.addFilter('markdown', (string) => {
+    if (!string) return '';
     return md.renderInline(string);
   });
 

.eleventyignore

@@ -1 +1,5 @@
 **/_*.md
+!src/docs/**
+src/docs/README*.md
+src/docs/viewer/**
+src/docs/**/*.html

.github/workflows/deploy.yml

@@ -15,6 +15,8 @@ jobs:
         with:
           node-version-file: '.nvmrc'
       - run: npm install
+      - name: Sync V8 docs
+        run: npm run sync-docs
       - run: npm run lint
       - run: npm run build
       - uses: FirebaseExtended/action-hosting-deploy@v0

.github/workflows/pr-build.yml

@@ -17,6 +17,8 @@ jobs:
         with:
           node-version-file: '.nvmrc'
       - run: npm install
+      - name: Sync V8 docs
+        run: npm run sync-docs
       - run: npm run lint
       - run: npm run build
       - uses: FirebaseExtended/action-hosting-deploy@v0

.gitignore

@@ -13,3 +13,8 @@ package-lock.json
 Desktop.ini
 ._*
 Thumbs.db
+.v8-tmp/
+# Ignore synced docs
+/src/docs/*
+!/src/docs/docs.json
+!/src/docs/README_V8_DEV.md

.html-minifier.json

@@ -5,6 +5,9 @@
   "conservativeCollapse": false,
   "decodeEntities": true,
   "html5": true,
+  "ignoreCustomFragments": [
+    "<pre[\\s\\S]*?<\\/pre>"
+  ],
   "includeAutoGeneratedTags": false,
   "minifyCSS": true,
   "minifyJS": true,

.markdownlintignore

@@ -0,0 +1 @@
+src/docs/

markdown-link-check.json

@@ -1,7 +1,48 @@
 {
+  "ignorePatterns": [
+    {
+      "pattern": "^https?://"
+    },
+    {
+      "pattern": "^mailto:"
+    },
+    {
+      "pattern": "^/bugs?$"
+    },
+    {
+      "pattern": "^\\.\\./\\.\\./src/"
+    },
+    {
+      "pattern": "^#"
+    },
+    {
+      "pattern": "torque(\\.md)?$"
+    },
+    {
+      "pattern": "torque-builtins(\\.md)?$"
+    },
+    {
+      "pattern": "csa-builtins(\\.md)?$"
+    },
+    {
+      "pattern": "turbofan(\\.md)?$"
+    },
+    {
+      "pattern": "ignition(\\.md)?$"
+    },
+    {
+      "pattern": "hidden-classes(\\.md)?$"
+    },
+    {
+      "pattern": "wasm-compilation-pipeline(\\.md)?$"
+    },
+    {
+      "pattern": "sandbox(\\.md)?$"
+    }
+  ],
   "replacementPatterns": [
     {
-      "pattern": "^/((docs|blog|features)/[\\w-]+)(?:#.*)?$",
+      "pattern": "^/((docs|blog|features)/[\\w/-]+)(?:#.*)?$",
       "replacement": "{{BASEURL}}/src/$1.md"
     },
     {

package.json

@@ -1,7 +1,8 @@
 {
   "private": true,
   "scripts": {
-    "lint": "markdownlint \"src/**/*.md\"",
+    "lint": "markdownlint \"src/**/*.md\" && npm run lint:links",
+    "lint:links": "markdown-link-check -q --config markdown-link-check.json src/docs/**/*.md",
     "eleventy": "eleventy",
     "html": "html-minifier-terser --config-file=.html-minifier.json --input-dir=dist --output-dir=dist --file-ext=html",
     "css": "postcss src/_css/main.css --output dist/_css/main.css && postcss src/_css/feature-support.css --output dist/_css/feature-support.css",
@@ -13,8 +14,9 @@
     "copy-js": "shx cp ./node_modules/dark-mode-toggle/dist/dark-mode-toggle.min.mjs dist/_js/dark-mode-toggle.mjs",
     "img-video-dimensions": "node add-image-and-video-dimensions.js",
     "clean": "shx rm -rf -- dist",
-    "build": "npm run clean && npm run css && npm run js && npm run json && npm run copy-img && npm run copy-js && npm run eleventy && npm run sw && npm run xml && npm run html",
-    "watch": "npm run build && npx eleventy --watch",
+    "sync-docs": "node sync-docs.mjs",
+    "build": "npm run clean && npm run sync-docs && npm run css && npm run js && npm run json && npm run copy-img && npm run copy-js && npm run eleventy && npm run sw && npm run xml && npm run html",
+    "watch": "npm run sync-docs && npm run build && npx eleventy --watch",
     "serve": "npm start",
     "dev": "npm start",
     "debug": "DEBUG=* npx eleventy",

prism-languages.js

@@ -12,6 +12,9 @@
 // limitations under the License.
 
 const installPrismLanguages = (Prism) => {
+  // Define an empty dummy language for 'text' so Prism does not fail
+  // when trying to highlight plain text blocks.
+  Prism.languages.text = {};
 
   // Based on the grammar defined at the bottom of:
   // https://cs.chromium.org/chromium/src/v8/src/torque/torque-parser.cc

src/docs/README_V8_DEV.md

@@ -0,0 +1,8 @@
+# V8 Documentation
+
+This folder is synced automatically during deployment.
+The main V8 documentation is hosted and updated directly in the [V8 repository](https://github.com/v8/v8/tree/main/docs).
+
+Any modifications to the documentation should be done in the V8 repository. The files here in `v8.dev` are synced continuously on build via GitHub actions.
+
+Only files that are specific to the `v8.dev` website rendering (such as `docs.json` or this README) should be committed to this directory.