Merge pull request #19233 from GordonSmith/HPCC-32868-VITEPRESS_VERSI…

…ON_BUMP HPCC-32868 Add ECL language support to VitePress
hpcc-systems · Oct 24, 2024 · bf0ac87 · bf0ac87
2 parents 3715af2 + bfb0b9b
commit bf0ac87
Show file tree

Hide file tree

Showing 6 changed files with 4,839 additions and 919 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -19,7 +19,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
 
       - run: npm ci
       - run: npm run build

diff --git a/devdoc/.vitepress/config.js b/devdoc/.vitepress/config.js
@@ -1,64 +1,80 @@
-export default {
-    title: 'HPCC Platform',
-    description: 'The HPCC-Platform from hpccsystems is an open source system for big data analysis. It uses a single language, platform and architecture to process data efficiently and fast.',
-    base: '/HPCC-Platform/',
-    srcDir: '..',
-    srcExclude: ["build/**", "dockerfiles/**", "docs/**", "esp/**", "helm/**", "initfiles/**", "plugins/**", "vcpkg/**"],
-    ignoreDeadLinks: true,
+import { defineConfig } from "vitepress";
+import { observable } from "@hpcc-js/markdown-it-plugins";
+import { eclLang } from "@hpcc-js/markdown-it-plugins/ecl-lang";
 
-    themeConfig: {
-        repo: "hpcc-systems/HPCC-Platform",
-        docsBranch: "master",
-        search: {
-            provider: 'local'
-        }, 
-        editLink: {
-            pattern: 'https://github.com/hpcc-systems/HPCC-Platform/edit/master/:path',
-            text: 'Edit this page on GitHub'
-        },
-        lastUpdated: "Last Updated",
-        nav: [
-            { text: 'Getting Started', link: '/devdoc/README' },
-            { text: 'hpccsystems.com', link: 'https://hpccsystems.com' },
-            { text: 'Changelog', link: 'https://hpccsystems.com/download/release-notes/' },
-        ],
-        socialLinks: [
-            { icon: 'github', link: 'https://github.com/hpcc-systems/HPCC-Platform' },
-            { icon: 'linkedin', link: 'https://www.linkedin.com/company/hpcc-systems/home' },
-            { icon: 'twitter', link: 'https://twitter.com/hpccsystems' },
-            { icon: 'facebook', link: 'https://www.facebook.com/hpccsystems' },
-            { icon: 'youtube', link: 'https://www.youtube.com/user/HPCCSystems' },
-        ],
-        sidebar: [
-            {
-                text: 'General',
-                items: [
-                    { text: 'Getting Started', link: '/devdoc/README' },
-                    { text: 'Development Guide', link: '/devdoc/Development' },
-                    { text: 'C++ Style Guide', link: '/devdoc/StyleGuide' },
-                    { text: 'ECL Style Guide', link: '/ecllibrary/StyleGuide.html' },
-                    { text: 'Code Submission Guidelines', link: '/devdoc/CodeSubmissions' },
-                    { text: 'Code Review Guidelines', link: '/devdoc/CodeReviews' },
-                    { text: 'Writing Developer Documentation', link: '/devdoc/DevDocs' },
-                    { text: 'User Guides', link: '/devdoc/userdoc/README' },
-                    { text: 'Build on Github Actions', link: '/devdoc/UserBuildAssets' },
-                ]
+// https://vitepress.dev/reference/site-config
+export default async () => {
+
+    return defineConfig({
+        title: 'HPCC Platform',
+        description: 'The HPCC-Platform from hpccsystems is an open source system for big data analysis. It uses a single language, platform and architecture to process data efficiently and fast.',
+        base: '/HPCC-Platform/',
+        srcDir: '..',
+        srcExclude: ["build-*/**", "build/**", "dockerfiles/**", "docs/**", "esp/**", "helm/**", "initfiles/**", "plugins/**", "vcpkg/**"],
+        ignoreDeadLinks: true,
+
+        themeConfig: {
+            search: {
+                provider: 'local'
+            },
+            editLink: {
+                pattern: 'https://github.com/hpcc-systems/HPCC-Platform/edit/master/:path',
+                text: 'Edit this page on GitHub'
             },
-            {
-                text: 'Other',
-                items: [
-                    { text: 'Workunit Workflow', link: '/devdoc/Workunits' },
-                    { text: 'Code Generator', link: '/devdoc/CodeGenerator' },
-                    { text: 'Roxie', link: '/devdoc/roxie' },
-                    { text: 'Memory Manager', link: '/devdoc/MemoryManager' },
-                    { text: 'Metrics', link: '/devdoc/Metrics' },
-                ]
+            lastUpdated: {
+                text: "Last Updated"
+            },
+            nav: [
+                { text: 'Getting Started', link: '/devdoc/README' },
+                { text: 'hpccsystems.com', link: 'https://hpccsystems.com' },
+                { text: 'Changelog', link: 'https://hpccsystems.com/download/release-notes/' },
+            ],
+            socialLinks: [
+                { icon: 'github', link: 'https://github.com/hpcc-systems/HPCC-Platform' },
+                { icon: 'linkedin', link: 'https://www.linkedin.com/company/hpcc-systems/home' },
+                { icon: 'twitter', link: 'https://twitter.com/hpccsystems' },
+                { icon: 'facebook', link: 'https://www.facebook.com/hpccsystems' },
+                { icon: 'youtube', link: 'https://www.youtube.com/user/HPCCSystems' },
+            ],
+            sidebar: [
+                {
+                    text: 'General',
+                    items: [
+                        { text: 'Getting Started', link: '/devdoc/README' },
+                        { text: 'Development Guide', link: '/devdoc/Development' },
+                        { text: 'C++ Style Guide', link: '/devdoc/StyleGuide' },
+                        { text: 'ECL Style Guide', link: '/ecllibrary/StyleGuide.html' },
+                        { text: 'Code Submission Guidelines', link: '/devdoc/CodeSubmissions' },
+                        { text: 'Code Review Guidelines', link: '/devdoc/CodeReviews' },
+                        { text: 'Writing Developer Documentation', link: '/devdoc/DevDocs' },
+                        { text: 'User Guides', link: '/devdoc/userdoc/README' },
+                        { text: 'Build on Github Actions', link: '/devdoc/UserBuildAssets' },
+                    ]
+                },
+                {
+                    text: 'Other',
+                    items: [
+                        { text: 'Workunit Workflow', link: '/devdoc/Workunits' },
+                        { text: 'Code Generator', link: '/devdoc/CodeGenerator' },
+                        { text: 'Roxie', link: '/devdoc/roxie' },
+                        { text: 'Memory Manager', link: '/devdoc/MemoryManager' },
+                        { text: 'Metrics', link: '/devdoc/Metrics' },
+                    ]
+                }
+
+            ],
+            footer: {
+                message: 'Released under the Apache-2.0 License.',
+                copyright: 'Copyright © 2023-present hpccsystems.com'
             }
+        },
+        markdown: {
+            // https://github.com/vuejs/vitepress/blob/main/src/node/markdown/markdown.ts
+            config: md => {
+                md.use(observable, { vitePress: true });
+            },
 
-        ],
-        footer: {
-            message: 'Released under the Apache-2.0 License.',
-            copyright: 'Copyright © 2023-present hpccsystems.com'
+            languages: [eclLang()],
         }
-    }
-}
+    });
+};
diff --git a/devdoc/.vitepress/theme/custom.css b/devdoc/.vitepress/theme/custom.css
diff --git a/devdoc/.vitepress/theme/index.js b/devdoc/.vitepress/theme/index.js
@@ -1,14 +1,18 @@
-import DefaultTheme from 'vitepress/theme'
-import './custom.css'
+// https://vitepress.dev/guide/custom-theme
+import { h } from "vue";
+import DefaultTheme from "vitepress/theme";
+import RenderComponent from "@hpcc-js/markdown-it-plugins/vitepress/RenderComponent.vue";
+import "@hpcc-js/markdown-it-plugins/vitepress/styles.ts";
 
 export default {
-  ...DefaultTheme,
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    });
+  },
+  enhanceApp({ app }) {
+    app.component("RenderComponent", RenderComponent);
+  },
 
-  enhanceApp(ctx) {
-    // extend default theme custom behaviour.
-    DefaultTheme.enhanceApp(ctx)
-
-    // register your custom global components
-    // ctx.app.component('MyGlobalComponent' /* ... */)
-  }
-}
+};