diff --git a/docs/locales/en.yml b/docs/locales/en.yml index 4e0069a6..d98c4585 100644 --- a/docs/locales/en.yml +++ b/docs/locales/en.yml @@ -2,6 +2,7 @@ gallery: tip: search nav: + config: Config guide: Guide theme: Themes addon: Addons diff --git a/docs/locales/zh-CN.yml b/docs/locales/zh-CN.yml index da08f9e3..06ba65dc 100644 --- a/docs/locales/zh-CN.yml +++ b/docs/locales/zh-CN.yml @@ -2,6 +2,7 @@ gallery: tip: 搜索 nav: + config: 配置 guide: 指南 theme: 主题 addon: 插件 diff --git a/docs/pages/guide/config/extend.md b/docs/pages/guide/config/extend.md index 3142b1d4..93caf717 100644 --- a/docs/pages/guide/config/extend.md +++ b/docs/pages/guide/config/extend.md @@ -5,6 +5,12 @@ categories: - config --- +::: tip + +扩展配置是 Valaxy 提供的高阶配置,允许你自定义更多与底层/构建相关的配置。 + +::: + 以下是所有的扩展配置项与相关类型。 > [packages/valaxy/node/type.ts](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy/node/types.ts) @@ -79,3 +85,92 @@ export default defineValaxyConfig({ } }) ``` + +### Vite + +你可以参见 [Vite 文档](https://vite.dev/config/shared-options.html) 自定义 Vite 相关配置。 + +```ts [valaxy.config.ts] +import { defineValaxyConfig } from 'valaxy' + +export default defineValaxyConfig({ + vite: { + plugins: [] + } +}) +``` + +### Markdown + +可自定义 Markdown 相关配置,如代码主题、区块内容、添加 `markdown-it` 插件、transformer 等。 + +效果参见: [Markdown](/guide/markdown)。 + +::: details valaxy/node/plugins/markdown/types.ts + +<<< @/../packages/valaxy/node/plugins/markdown/types.ts + +::: + +```ts [valaxy.config.ts] +import { defineValaxyConfig } from 'valaxy' + +export default defineValaxyConfig({ + markdown: { + // default material-theme-palenight + // theme: 'material-theme-palenight', + theme: { + // light: 'material-theme-lighter', + light: 'github-light', + // dark: 'material-theme-darker', + dark: 'github-dark', + }, + + blocks: { + tip: { + icon: 'i-carbon-thumbs-up', + text: 'ヒント', + langs: { + 'zh-CN': '提示', + }, + }, + warning: { + icon: 'i-carbon-warning-alt', + text: '注意', + }, + danger: { + icon: 'i-carbon-warning', + text: '警告', + }, + info: { + text: 'información', + }, + }, + + codeTransformers: [ + // We use `[!!code` in demo to prevent transformation, here we revert it back. + { + postprocess(code) { + return code.replace(/\[!!code/g, '[!code') + }, + }, + ], + + config(md) { + // md.use(xxx) + } + }, +}) +``` + +### DevTools + +设置 `devtools: false` 以关闭 DevTools。 + +### 插件 addons + +参见 [使用插件](/addons/use)。 + +### UnoCSS + +参见 [UnoCSS](/guide/config/unocss-options)。 diff --git a/docs/pages/guide/config/index.md b/docs/pages/guide/config/index.md index 1038b94f..2efa518c 100644 --- a/docs/pages/guide/config/index.md +++ b/docs/pages/guide/config/index.md @@ -192,6 +192,23 @@ export default defineSiteConfig({ ::: +### 作者信息 + +更多字段可参考上文类型或直接在编辑器提示中查看。 + +```ts [site.config.ts] +import { defineSiteConfig } from 'valaxy' + +export default defineSiteConfig({ + author: { + name: '你的名字', + // 你的头像 + avatar: 'https://xxx', + intro: '个人简介' + } +}) +``` + ### Default Frontmatter ::: zh-CN @@ -760,6 +777,16 @@ export default defineSiteConfig({ }) ``` +### 更多配置 + +> 更多详细配置可参见 [types/config.ts](https://github.com/YunYouJun/valaxy/blob/main/packages/valaxy/types/config.ts)。 + +::: details packages/valaxy/types/config.ts SiteConfig + +<<< @/../packages/valaxy/types/config.ts#snippet{ts:line-numbers} + +::: + ## 主题配置 {lang="zh-CN"} ## Theme Config {lang="en"} @@ -771,3 +798,7 @@ export default defineSiteConfig({ ::: en Please refer to [Using Themes](/themes/use) and the theme you are using to configure it. ::: + +## 扩展配置 + +更多高阶配置请参见 [扩展配置](/guide/config/extend)。 diff --git a/docs/valaxy.config.ts b/docs/valaxy.config.ts index 7d1e12cc..1a60dfdd 100644 --- a/docs/valaxy.config.ts +++ b/docs/valaxy.config.ts @@ -95,6 +95,10 @@ export default defineValaxyConfig({ }, ], }, + { + text: 'nav.config', + link: '/guide/config/', + }, { text: 'API', link: 'https://api.valaxy.site/', diff --git a/packages/valaxy-theme-press/components/ValaxyMain.vue b/packages/valaxy-theme-press/components/ValaxyMain.vue index a8102918..b75d1ab6 100644 --- a/packages/valaxy-theme-press/components/ValaxyMain.vue +++ b/packages/valaxy-theme-press/components/ValaxyMain.vue @@ -61,16 +61,14 @@ onContentUpdated(() => { - - -

- {{ localeTitle }} -