fix deploy docs (#686)

* fix deploy docs

* gen new logo

* ignore also ico

* rename to ico

Author: lazarusA

.gitignore

@@ -25,4 +25,5 @@ docs/src/.vitepress/cache
 node_modules
 docs/package-lock.json
 *.png
-*.svg
+*.svg
+*.ico

docs/logo.jl

@@ -39,6 +39,7 @@ meshscatter!(ax, base_points; marker=Rect3f(Vec3f(-0.5,-0.5,0), Vec3f(1,1,1)),
     markersize = Vec3f.(0.5,0.5, z), color=z, colormap=tuple.(colors, 1), transparency=false)
 
 mkpath(joinpath(@__DIR__, "src", "assets"))
-save(joinpath(@__DIR__, "src", "assets", "logoDD.svg"), fig; pt_per_unit=0.75)
-save(joinpath(@__DIR__, "src", "assets", "logoDD.png"), fig; px_per_unit=2)
-save(joinpath(@__DIR__, "src", "assets", "favicon.png"), fig; px_per_unit=0.25)
+save(joinpath(@__DIR__, "src", "assets", "logo.svg"), fig; pt_per_unit=0.75)
+save(joinpath(@__DIR__, "src", "assets", "logo.png"), fig; px_per_unit=2)
+save(joinpath(@__DIR__, "src", "assets", "favicon.png"), fig; px_per_unit=0.25)
+mv(joinpath(@__DIR__, "src", "assets", "favicon.png"), joinpath(@__DIR__, "src", "assets", "favicon.ico"))

docs/make.jl

@@ -23,7 +23,7 @@ makedocs(; sitename="DimensionalData", authors="Rafael Schouten et al.",
     draft=false,
     source="src", 
     build="build", 
-    # warnonly = true,
+    warnonly = true,
 )
 
 # Deploy built documentation.

docs/package.json

@@ -1,18 +1,16 @@
 {
-  "devDependencies": {
-    "markdown-it": "^14.0.0",
-    "markdown-it-mathjax3": "^4.3.2",
-    "vitepress": "^1.0.0-rc.43",
-    "vitepress-plugin-tabs": "^0.5.0",
-    "vitest": "^1.3.0"
-  },
   "scripts": {
     "docs:dev": "vitepress dev build/.documenter",
     "docs:build": "vitepress build build/.documenter",
     "docs:preview": "vitepress preview build/.documenter"
   },
+  "devDependencies": {
+    "markdown-it-mathjax3": "^4.3.2",
+    "vitepress": "^1.0.2",
+    "vitepress-plugin-tabs": "^0.5.0"
+  },
   "dependencies": {
-    "@shikijs/transformers": "^1.1.7",
+    "markdown-it": "^14.1.0",
     "markdown-it-footnote": "^4.0.0"
   }
-}
+}

docs/src/.vitepress/config.mts

@@ -6,13 +6,12 @@ import footnote from "markdown-it-footnote";
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
-  title: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+  title: 'DimensionalData.jl',
   description: "Datasets with named dimensions",
   lastUpdated: true,
   cleanUrls: true,
   outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
-  head: [],
-  ignoreDeadLinks: true,
+  head: [['link', { rel: 'icon', href: '/DimensionalData.jl/favicon.ico' }]],
 
   markdown: {
     math: true,
@@ -28,7 +27,7 @@ export default defineConfig({
   },
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
-    logo: { src: '/logoDD.png', width: 24, height: 24 },
+    logo: { src: '/logo.png', width: 24, height: 24 },
     search: {
       provider: 'local',
       options: {
@@ -41,8 +40,9 @@ export default defineConfig({
       { text: 'Dimensions', link: '/dimensions' },
       { text: 'DimArrays', link: '/dimarrays' },
       { text: 'Selectors', link: '/selectors' },
-      { text: 'Integrations', link: '/integrations',
+      { text: 'Integrations',
         items: [
+          { text: 'Integrations', link: '/integrations'},
           { text: 'Plots and Makie', link: '/plots' },
           { text: 'Tables and DataFrames', link: '/tables' },
           { text: 'CUDA and GPUs', link: '/cuda' },

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

@@ -0,0 +1,13 @@
+// .vitepress/theme/index.ts
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+
+import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app }) {
+    enhanceAppWithTabs(app)
+  }
+} satisfies Theme

docs/src/groupby.md

@@ -274,7 +274,8 @@ groupby(A, Ti => hours(12; start=6, labels=x -> 6 in x ? :night : :day))
 
 :::
 
-## Select by [`Dimension`](@ref)
+## Select by Dimension
+- [`Dimension`](@ref)
 
 We can also select by `Dimension`s and any objects with `dims` methods.
 

docs/src/index.md

@@ -8,7 +8,7 @@ hero:
   text: "Julia datasets with named dimensions"
   tagline: High performance named indexing for Julia
   image:
-    src: 'logoDD.png'
+    src: 'logo.png'
   actions:
     - theme: brand
       text: Getting Started