Merge pull request #63 from DHTMLX/next

[dev] Update doc engine to v3.9.1 and node to v20

Author: serhiipylypchuk1991

.github/workflows/main.yml

@@ -2,11 +2,11 @@
 
 name: Deploy To Site
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [ master, next ]
+    branches: [master, next]
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -24,13 +24,13 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '18.19.0'
+          node-version: "20.0"
 
       - run: yarn install
       - run: yarn build
 
       - uses: docker/setup-buildx-action@v1
-      - uses: docker/login-action@v1 
+      - uses: docker/login-action@v1
         with:
           username: ${{ secrets.REGISTRY_USERNAME }}
           password: ${{ secrets.REGISTRY_TOKEN }}
@@ -41,4 +41,25 @@ jobs:
           push: true
           tags: registry.webix.io/diagram-docs-alt:${{ steps.vars.outputs.short_ref }}
 
-      - run: curl "https://docs.dhtmlx.com/hooks/restart-docker?token=${{ secrets.RESTART_TOKEN }}&project=docs-diagram-alt-${{ steps.vars.outputs.short_ref }}"
+      - run: curl "https://docs.dhtmlx.com/hooks/restart-docker?token=${{ secrets.RESTART_TOKEN }}&project=docs-diagram-alt-${{ steps.vars.outputs.short_ref }}"
+
+  algolia-crawl:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Wait for Deployment
+        run: sleep 30
+
+      - name: Algolia Crawler Creation and Crawl
+        uses: algolia/[email protected]
+        with:
+          crawler-user-id: ${{ secrets.CRAWLER_USER_ID }}
+          crawler-api-key: ${{ secrets.CRAWLER_API_KEY }}
+          algolia-app-id: ${{ secrets.ALGOLIA_APP_ID }}
+          algolia-api-key: ${{ secrets.ALGOLIA_API_KEY }}
+          site-url: "https://docs.dhtmlx.com/diagram/"
+          crawler-name: "Diagram Docs Crawler"
+          override-config: true

docusaurus.config.js

@@ -132,13 +132,18 @@ module.exports = {
     onBrokenLinks: 'warn',
 	onBrokenMarkdownLinks: 'warn',
     onBrokenAnchors: 'warn',
-    //onBrokenLinks: 'ignore', // !!! TODO, make to warn before release 
-    //onBrokenAnchors: 'ignore', // !!! TODO, make to warn before release 
-    onBrokenMarkdownLinks: 'ignore',
+    // onBrokenLinks: 'ignore', // !!! TODO, make to warn before release 
+    // onBrokenAnchors: 'ignore', // !!! TODO, make to warn before release 
+    // onBrokenMarkdownLinks: 'warn', // deprecated in v3.9.1
     favicon: 'img/favicon.ico',
     organizationName: 'DHTMLX', // Usually your GitHub org/user name
     projectName: 'docs-diagram', // Usually your repo name
     trailingSlash: true,
+    markdown: {
+		hooks: {
+			onBrokenMarkdownLinks: 'warn',
+		}
+	},
     themeConfig: {
         /*colorMode: {
             // "light" | "dark"

package.json

@@ -13,8 +13,8 @@
     "normalizeLink": "cd plugins && node samplesLinksNormalize.js"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.7.0",
-    "@docusaurus/preset-classic": "^3.7.0",
+    "@docusaurus/core": "^3.9.1",
+    "@docusaurus/preset-classic": "^3.9.1",
     "@mdx-js/react": "^3.0.0",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
@@ -37,13 +37,13 @@
     ]
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.7.0",
-    "@docusaurus/types": "^3.7.0",
+    "@docusaurus/module-type-aliases": "^3.9.1",
+    "@docusaurus/types": "^3.9.1",
     "dhx-md-data-parser": "file:local_modules/dhx-md-data-parser",
     "docusaurus-plugin-sass": "^0.2.5",
     "webpack-cli": "^4.4.0"
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.0"
   }
 }