From c43d077873b2719eb1f732b165c1aab033d0c5ab Mon Sep 17 00:00:00 2001 From: Dominik Nakamura Date: Wed, 3 Jan 2024 02:02:38 +0900 Subject: [PATCH] doc(book): tweak colors and page details Adjust the branding colors for better visual contrast and flip a few config values of Vitepress. --- .editorconfig | 2 +- book/.editorconfig | 2 +- book/.vitepress/{config.mjs => config.mts} | 16 +++++++++------- book/.vitepress/theme/index.ts | 4 ++++ book/.vitepress/theme/style.css | 11 +++++++++++ book/package.json | 2 +- book/src/index.md | 9 ++------- 7 files changed, 29 insertions(+), 17 deletions(-) rename book/.vitepress/{config.mjs => config.mts} (93%) create mode 100644 book/.vitepress/theme/index.ts create mode 100644 book/.vitepress/theme/style.css diff --git a/.editorconfig b/.editorconfig index 9e0ba60..9d0ebb3 100644 --- a/.editorconfig +++ b/.editorconfig @@ -6,7 +6,7 @@ indent_size = 4 insert_final_newline = true trim_trailing_whitespace = true -[*.{html,js,json,yaml,yml}] +[*.{css,html,json,mts,svg,ts,yaml,yml}] indent_size = 2 [Justfile] diff --git a/book/.editorconfig b/book/.editorconfig index cda71bd..714b952 100644 --- a/book/.editorconfig +++ b/book/.editorconfig @@ -1,4 +1,4 @@ -[*.{md,svg}] +[*.md] indent_size = 2 [*.kt] diff --git a/book/.vitepress/config.mjs b/book/.vitepress/config.mts similarity index 93% rename from book/.vitepress/config.mjs rename to book/.vitepress/config.mts index fa06e43..7bca826 100644 --- a/book/.vitepress/config.mjs +++ b/book/.vitepress/config.mts @@ -5,8 +5,10 @@ import maboGrammar from "../../vscode-extension/syntaxes/mabo.tmLanguage.json"; export default defineConfig({ title: "mabo", description: "Strongly Typed Encoding Format", + appearance: "dark", + lastUpdated: true, srcDir: "src", - base: "/mabo", + base: "/mabo/", markdown: { theme: { dark: "one-dark-pro", @@ -14,11 +16,15 @@ export default defineConfig({ }, languages: [ { - ...maboGrammar, + // biome-ignore lint: the grammar is wrongly reported as incompatible + ...(maboGrammar as any), name: "mabo", }, ], lineNumbers: true, + image: { + lazyLoading: true, + }, }, vite: { resolve: { @@ -31,6 +37,7 @@ export default defineConfig({ logo: "/logo.svg", editLink: { pattern: "https://github.com/dnaka91/mabo/edit/main/book/src/:path", + text: "Edit this page on GitHub", }, nav: [ { text: "Guide", link: "/guide/installation", activeMatch: "/guide/" }, @@ -114,11 +121,6 @@ export default defineConfig({ copyright: "Copyright © 2023-present Dominik Nakamura", }, - docFooter: { - prev: false, - next: false, - }, - search: { provider: "local", }, diff --git a/book/.vitepress/theme/index.ts b/book/.vitepress/theme/index.ts new file mode 100644 index 0000000..617deeb --- /dev/null +++ b/book/.vitepress/theme/index.ts @@ -0,0 +1,4 @@ +import DefaultTheme from "vitepress/theme"; +import "./style.css"; + +export default DefaultTheme; diff --git a/book/.vitepress/theme/style.css b/book/.vitepress/theme/style.css new file mode 100644 index 0000000..6e57b7b --- /dev/null +++ b/book/.vitepress/theme/style.css @@ -0,0 +1,11 @@ +:root { + --vp-c-brand-1: hwb(25 0% 15%); + --vp-c-brand-2: hwb(35 0% 15%); + --vp-c-brand-3: hwb(15 0% 15%); +} + +.dark { + --vp-c-brand-1: hwb(25 20% 0%); + --vp-c-brand-2: hwb(35 20% 0%); + --vp-c-brand-3: hwb(15 20% 0%); +} diff --git a/book/package.json b/book/package.json index d3e87ea..c924f03 100644 --- a/book/package.json +++ b/book/package.json @@ -5,7 +5,7 @@ "dev": "vitepress dev", "build": "vitepress build", "preview": "vitepress preview", - "lint": "biome check --apply .vitepress/config.mjs src/**/*.md" + "lint": "biome check --apply .vitepress/config.mts src/**/*.md" }, "devDependencies": { "@biomejs/biome": "^1.4.1", diff --git a/book/src/index.md b/book/src/index.md index b7a66a3..1b33894 100644 --- a/book/src/index.md +++ b/book/src/index.md @@ -30,15 +30,10 @@ features: ---