Merge pull request #571 from LuxDL/ap/stable_docs

Try fixing the hydration error

.buildkite/pipeline.yml

@@ -182,6 +182,10 @@ steps:
       npm i
       cd ..
 
+      echo $BUILDKITE
+      echo $BUILDKITE_PULL_REQUEST
+      echo $BUILDKITE_TAG
+
       julia --project --code-coverage=user --color=yes --threads=auto --project=docs -e '
         println("--- :julia: Instantiating project")
         using Pkg
@@ -205,6 +209,7 @@ steps:
     env:
       DATADEPS_ALWAYS_ACCEPT: true
       JULIA_DEBUG: "Documenter"
+      DEBUG: true
       GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988
     if: build.message !~ /\[skip docs\]/ && !build.pull_request.draft
     timeout_in_minutes: 240

Project.toml

@@ -1,7 +1,7 @@
 name = "Lux"
 uuid = "b2108857-7c20-44ae-9111-449ecde12c47"
 authors = ["Avik Pal <avikpal@mit.edu> and contributors"]
-version = "0.5.31"
+version = "0.5.32"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"

docs/Project.toml

@@ -16,6 +16,3 @@ Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 WeightInitializers = "d49dbf32-c5c2-4618-8acc-27bb2598ef2d"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
-
-[compat]
-DocumenterVitepress = "0.0.13"

docs/package.json

@@ -1,8 +1,8 @@
 {
   "devDependencies": {
-    "markdown-it": "^14.0.0",
+    "markdown-it": "^14.1.0",
     "markdown-it-mathjax3": "^4.3.2",
-    "vitepress": "^1.0.0-rc.43",
+    "vitepress": "^1.0.2",
     "vitepress-plugin-tabs": "^0.5.0",
     "vitest": "^1.3.0"
   },

docs/src/.vitepress/config.mts

@@ -11,6 +11,7 @@ export default defineConfig({
     description: 'Documentation for LuxDL Repositories',
     cleanUrls: true,
     outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
+    lastUpdated: true,
 
     markdown: {
         math: true,
@@ -24,8 +25,28 @@ export default defineConfig({
             dark: "github-dark"
         },
         codeTransformers: [transformerMetaWordHighlight(),],
-
     },
+
+    head: [
+        [
+            "script",
+            { async: "", src: "https://www.googletagmanager.com/gtag/js?id=G-Q8GYTEVTZ2" },
+        ],
+        [
+            "script",
+            {},
+            `window.dataLayer = window.dataLayer || [];
+          function gtag(){dataLayer.push(arguments);}
+          gtag('js', new Date());
+          gtag('config', 'G-Q8GYTEVTZ2');`,
+        ],
+        ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
+        ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
+        ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
+        ['link', { rel: 'icon', href: '/favicon.ico' }],
+        ['link', { rel: 'manifest', href: '/site.webmanifest' }],
+    ],
+
     themeConfig: {
         outline: 'deep',
         // https://vitepress.dev/reference/default-theme-config
@@ -171,24 +192,6 @@ export default defineConfig({
             message: 'Made with <a href="https://documenter.juliadocs.org/stable/" target="_blank"><strong>Documenter.jl</strong></a>, <a href="https://vitepress.dev" target="_blank"><strong>VitePress</strong></a> and <a href="https://luxdl.github.io/DocumenterVitepress.jl/stable" target="_blank"><strong>DocumenterVitepress.jl</strong></a><br>Released under the MIT License. Powered by the <a href="https://www.julialang.org">Julia Programming Language</a>.<br>',
             copyright: `© Copyright ${new Date().getUTCFullYear()} Avik Pal.`
         },
-        head: [
-            [
-                "script",
-                { async: "", src: "https://www.googletagmanager.com/gtag/js?id=G-Q8GYTEVTZ2" },
-            ],
-            [
-                "script",
-                {},
-                `window.dataLayer = window.dataLayer || [];
-              function gtag(){dataLayer.push(arguments);}
-              gtag('js', new Date());
-              gtag('config', 'G-Q8GYTEVTZ2');`,
-            ],
-            ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' }],
-            ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' }],
-            ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicon-16x16.png' }],
-            ['link', { rel: 'manifest', href: '/site.webmanifest' }],
-        ],
         lastUpdated: {
             text: 'Updated at',
             formatOptions: {

docs/src/.vitepress/theme/index.ts

@@ -11,11 +11,10 @@ export default {
   extends: DefaultTheme,
   Layout() {
     return h(DefaultTheme.Layout, null, {
-      // 'home-hero-info-after': () => h(HomeTrustees),
       'aside-ads-before': () => h(AsideTrustees),
     })
   },
-  enhanceApp({ app, router, siteData }) {
+  enhanceApp({ app }) {
     enhanceAppWithTabs(app)
   }
 } satisfies Theme

docs/src/index.md

@@ -27,12 +27,12 @@ hero:
 features:
   - icon: 🚀
     title: Fast & Extendible
-    details: Lux.jl is written in Julia itself, making it extremely extendible. <u><a href="https://github.com/JuliaGPU/CUDA.jl">CUDA</a></u> and <u><a href="https://github.com/JuliaGPU/AMDGPU.jl">AMDGPU</a></u> are supported first-class, with experimental support for <u><a href="https://github.com/JuliaGPU/Metal.jl">Metal</a></u> Hardware.
+    details: Lux.jl is written in Julia itself, making it extremely extendible. CUDA and AMDGPU are supported first-class, with experimental support for Metal Hardware.
     link: /introduction/
 
   - icon: 🧑‍🔬
     title: SciML ❤️ Lux
-    details: Lux is the default choice for many <u><a href="https://github.com/SciML">SciML</a></u> packages, including DiffEqFlux.jl, NeuralPDE.jl, and more.
+    details: Lux is the default choice for many SciML packages, including DiffEqFlux.jl, NeuralPDE.jl, and more.
     link: https://sciml.ai/
 
   - icon: 🧩