From 7407d6aa65abdb5b24bb664f3feaed71cc1d62a3 Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Tue, 21 Jan 2025 21:37:17 +0100 Subject: [PATCH 1/5] enhance --- docs/package.json | 5 +++-- docs/src/.vitepress/config.mts | 16 +++++++++++++++- docs/src/.vitepress/theme/index.ts | 14 +++++++++++++- template/package.json | 5 +++-- template/src/.vitepress/config.mts | 17 ++++++++++++++++- template/src/.vitepress/theme/index.ts | 13 ++++++++++++- 6 files changed, 62 insertions(+), 8 deletions(-) diff --git a/docs/package.json b/docs/package.json index d87251ef..bc245755 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,10 +1,11 @@ { "devDependencies": { + "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.12.1", "@types/d3-format": "^3.0.4", - "@types/node": "^22.10.5", + "@types/node": "^22.10.7", "markdown-it": "^14.1.0", "markdown-it-mathjax3": "^4.3.2", - "vitepress": "^1.5.0", + "vitepress": "^1.6.1", "vitepress-plugin-tabs": "^0.5.0" }, "scripts": { diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index 1db99f48..3db7a91a 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -40,7 +40,21 @@ export default defineConfig({ vite: { build: { assetsInlineLimit: 0, // so we can tell whether we have created inlined images or not, we don't let vite inline them - } + }, + optimizeDeps: { + exclude: [ + '@nolebase/vitepress-plugin-enhanced-readabilities/client', + 'vitepress', + '@nolebase/ui', + ], + }, + ssr: { + noExternal: [ + // If there are other packages that need to be processed by Vite, you can add them here. + '@nolebase/vitepress-plugin-enhanced-readabilities', + '@nolebase/ui', + ], + }, }, markdown: { diff --git a/docs/src/.vitepress/theme/index.ts b/docs/src/.vitepress/theme/index.ts index 6bcccb4d..e0a4eadd 100644 --- a/docs/src/.vitepress/theme/index.ts +++ b/docs/src/.vitepress/theme/index.ts @@ -1,6 +1,13 @@ // .vitepress/theme/index.ts import { h } from 'vue' import type { Theme } from 'vitepress' +import { + NolebaseEnhancedReadabilitiesMenu, + NolebaseEnhancedReadabilitiesScreenMenu, +} from '@nolebase/vitepress-plugin-enhanced-readabilities/client' + +import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css' + import DefaultTheme from 'vitepress/theme' import AsideTrustees from '../../components/AsideTrustees.vue' import VersionPicker from "../../components/VersionPicker.vue" @@ -15,7 +22,12 @@ export default { Layout() { return h(DefaultTheme.Layout, null, { 'aside-ads-before': () => h(AsideTrustees), - 'nav-bar-content-after': () => h(StarUs), + 'nav-bar-content-after': () => [ + h(StarUs), + h(NolebaseEnhancedReadabilitiesMenu), // Enhanced Readabilities menu + ], + // A enhanced readabilities menu for narrower screens (usually smaller than iPad Mini) + 'nav-screen-content-after': () => h(NolebaseEnhancedReadabilitiesScreenMenu), }) }, enhanceApp({ app, router, siteData }) { diff --git a/template/package.json b/template/package.json index d7456f24..d00a7b2b 100644 --- a/template/package.json +++ b/template/package.json @@ -5,11 +5,12 @@ "docs:preview": "vitepress preview build/.documenter" }, "dependencies": { - "@shikijs/transformers": "^1.1.7", + "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.12.1", + "@shikijs/transformers": "^2.0.3", "markdown-it": "^14.1.0", "markdown-it-footnote": "^4.0.0", "markdown-it-mathjax3": "^4.3.2", - "vitepress": "^1.5.0", + "vitepress": "^1.6.1", "vitepress-plugin-tabs": "^0.5.0" } } diff --git a/template/src/.vitepress/config.mts b/template/src/.vitepress/config.mts index eb7bc481..64654d17 100644 --- a/template/src/.vitepress/config.mts +++ b/template/src/.vitepress/config.mts @@ -39,7 +39,22 @@ export default defineConfig({ ['script', {src: `${baseTemp.base}siteinfo.js`}] ], ignoreDeadLinks: true, - + vite: { + optimizeDeps: { + exclude: [ + '@nolebase/vitepress-plugin-enhanced-readabilities/client', + 'vitepress', + '@nolebase/ui', + ], + }, + ssr: { + noExternal: [ + // If there are other packages that need to be processed by Vite, you can add them here. + '@nolebase/vitepress-plugin-enhanced-readabilities', + '@nolebase/ui', + ], + }, + }, markdown: { math: true, config(md) { diff --git a/template/src/.vitepress/theme/index.ts b/template/src/.vitepress/theme/index.ts index cd149bec..c5381dd8 100644 --- a/template/src/.vitepress/theme/index.ts +++ b/template/src/.vitepress/theme/index.ts @@ -1,6 +1,13 @@ // .vitepress/theme/index.ts import { h } from 'vue' import type { Theme } from 'vitepress' +import { + NolebaseEnhancedReadabilitiesMenu, + NolebaseEnhancedReadabilitiesScreenMenu, +} from '@nolebase/vitepress-plugin-enhanced-readabilities/client' + +import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css' + import DefaultTheme from 'vitepress/theme' import VersionPicker from "../../components/VersionPicker.vue" import AuthorBadge from '../../components/AuthorBadge.vue' @@ -13,7 +20,11 @@ export default { extends: DefaultTheme, Layout() { return h(DefaultTheme.Layout, null, { - // https://vitepress.dev/guide/extending-default-theme#layout-slots + 'nav-bar-content-after': () => [ + h(NolebaseEnhancedReadabilitiesMenu), // Enhanced Readabilities menu + ], + // A enhanced readabilities menu for narrower screens (usually smaller than iPad Mini) + 'nav-screen-content-after': () => h(NolebaseEnhancedReadabilitiesScreenMenu), }) }, enhanceApp({ app, router, siteData }) { From 0e4dd7a128fd14e716fb8eaf1847ff26754350da Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Wed, 22 Jan 2025 22:51:19 +0100 Subject: [PATCH 2/5] update version --- docs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/package.json b/docs/package.json index bc245755..1ced7efe 100644 --- a/docs/package.json +++ b/docs/package.json @@ -5,7 +5,7 @@ "@types/node": "^22.10.7", "markdown-it": "^14.1.0", "markdown-it-mathjax3": "^4.3.2", - "vitepress": "^1.6.1", + "vitepress": "^1.6.3", "vitepress-plugin-tabs": "^0.5.0" }, "scripts": { From 8eaf5a43ed501c0bea06a70108c7ae0e61eef98c Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Thu, 23 Jan 2025 17:59:29 +0100 Subject: [PATCH 3/5] fixes to Theme config --- docs/package.json | 2 +- docs/src/.vitepress/theme/index.ts | 14 ++++++++------ template/package.json | 2 +- template/src/.vitepress/theme/index.ts | 14 ++++++++------ 4 files changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/package.json b/docs/package.json index 1ced7efe..68f3f0d9 100644 --- a/docs/package.json +++ b/docs/package.json @@ -2,7 +2,7 @@ "devDependencies": { "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.12.1", "@types/d3-format": "^3.0.4", - "@types/node": "^22.10.7", + "@types/node": "^22.10.9", "markdown-it": "^14.1.0", "markdown-it-mathjax3": "^4.3.2", "vitepress": "^1.6.3", diff --git a/docs/src/.vitepress/theme/index.ts b/docs/src/.vitepress/theme/index.ts index e0a4eadd..e673d3db 100644 --- a/docs/src/.vitepress/theme/index.ts +++ b/docs/src/.vitepress/theme/index.ts @@ -1,23 +1,24 @@ // .vitepress/theme/index.ts import { h } from 'vue' -import type { Theme } from 'vitepress' +import DefaultTheme from 'vitepress/theme' +import type { Theme as ThemeConfig } from 'vitepress' + import { NolebaseEnhancedReadabilitiesMenu, NolebaseEnhancedReadabilitiesScreenMenu, } from '@nolebase/vitepress-plugin-enhanced-readabilities/client' -import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css' - -import DefaultTheme from 'vitepress/theme' import AsideTrustees from '../../components/AsideTrustees.vue' import VersionPicker from "../../components/VersionPicker.vue" import StarUs from '../../components/StarUs.vue' import AuthorBadge from '../../components/AuthorBadge.vue' import Authors from '../../components/Authors.vue' import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client' + +import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css' import './style.css' -export default { +export const Theme: ThemeConfig = { extends: DefaultTheme, Layout() { return h(DefaultTheme.Layout, null, { @@ -36,4 +37,5 @@ export default { app.component('AuthorBadge', AuthorBadge) app.component('Authors', Authors) } -} satisfies Theme \ No newline at end of file +} +export default Theme \ No newline at end of file diff --git a/template/package.json b/template/package.json index d00a7b2b..d45cf531 100644 --- a/template/package.json +++ b/template/package.json @@ -10,7 +10,7 @@ "markdown-it": "^14.1.0", "markdown-it-footnote": "^4.0.0", "markdown-it-mathjax3": "^4.3.2", - "vitepress": "^1.6.1", + "vitepress": "^1.6.3", "vitepress-plugin-tabs": "^0.5.0" } } diff --git a/template/src/.vitepress/theme/index.ts b/template/src/.vitepress/theme/index.ts index c5381dd8..f2ce71e3 100644 --- a/template/src/.vitepress/theme/index.ts +++ b/template/src/.vitepress/theme/index.ts @@ -1,22 +1,23 @@ // .vitepress/theme/index.ts import { h } from 'vue' -import type { Theme } from 'vitepress' +import DefaultTheme from 'vitepress/theme' +import type { Theme as ThemeConfig } from 'vitepress' + import { NolebaseEnhancedReadabilitiesMenu, NolebaseEnhancedReadabilitiesScreenMenu, } from '@nolebase/vitepress-plugin-enhanced-readabilities/client' -import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css' - -import DefaultTheme from 'vitepress/theme' import VersionPicker from "../../components/VersionPicker.vue" import AuthorBadge from '../../components/AuthorBadge.vue' import Authors from '../../components/Authors.vue' import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client' + +import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css' import './style.css' -export default { +export const Theme: ThemeConfig = { extends: DefaultTheme, Layout() { return h(DefaultTheme.Layout, null, { @@ -33,4 +34,5 @@ export default { app.component('AuthorBadge', AuthorBadge) app.component('Authors', Authors) } -} satisfies Theme \ No newline at end of file +} +export default Theme \ No newline at end of file From f5d19aa6e6a62c20c362d24d7e4e5923b344250b Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Thu, 23 Jan 2025 18:30:28 +0100 Subject: [PATCH 4/5] renames nav menu --- docs/make.jl | 5 ++--- docs/src/{getting_started.md => get_started.md} | 2 +- docs/src/index.md | 4 ++-- 3 files changed, 5 insertions(+), 6 deletions(-) rename docs/src/{getting_started.md => get_started.md} (99%) diff --git a/docs/make.jl b/docs/make.jl index 9d3e80b8..b2da91a8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -41,9 +41,8 @@ makedocs(; source = "src", build = "build", pages = [ - "Home" => "index.md", - "Getting started" => "getting_started.md", - "Examples" => [ + "Manual" => [ + "Get Started" => "get_started.md", "Code" => "code_example.md", "Markdown" => "markdown-examples.md", "MIME output" => "mime_examples.md", diff --git a/docs/src/getting_started.md b/docs/src/get_started.md similarity index 99% rename from docs/src/getting_started.md rename to docs/src/get_started.md index 8e79f869..4d7af786 100644 --- a/docs/src/getting_started.md +++ b/docs/src/get_started.md @@ -1,4 +1,4 @@ -# Getting started +# Get Started ## Simple method diff --git a/docs/src/index.md b/docs/src/index.md index 2263bded..51f9e233 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -12,8 +12,8 @@ hero: alt: DocumenterVitepress actions: - theme: brand - text: Getting Started - link: /getting_started + text: Get Started + link: /get_started - theme: alt text: View on Github link: https://github.com/LuxDL/DocumenterVitepress.jl From 4fb8b2caba9b8c2b869dcdd12e494b5851e5e176 Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Thu, 23 Jan 2025 19:46:23 +0100 Subject: [PATCH 5/5] move update up --- docs/make.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index b2da91a8..26c2edd5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -43,10 +43,10 @@ makedocs(; pages = [ "Manual" => [ "Get Started" => "get_started.md", + "Updating to DocumenterVitepress" => "documenter_to_vitepress_docs_example.md", "Code" => "code_example.md", "Markdown" => "markdown-examples.md", "MIME output" => "mime_examples.md", - "Updating to DocumenterVitepress" => "documenter_to_vitepress_docs_example.md", "DocumenterCitations integration" => "citations.md", "CSS Styling" => "style_css.md", "Authors' badge" => "author_badge.md",