Moodji 文档中心
首页
下载App
  • 简体中文
  • English
  • 日本語
  • 한국어
首页
下载App
  • 简体中文
  • English
  • 日本語
  • 한국어
  • 嗨,我是 Moodji

    • 懂你的 Watch 伴侣
    • 🚀 快速上手
  • 价值主张

    • 🎯 Moodji 想解决什么问题?
    • 自动的记录
    • 温柔的觉察
    • 可持续的行动
  • 用户手册

    • 🧱 色块、状态
    • 📊 状态记录、周报、趋势
    • 😺 表情贴纸、每月活动
    • ⌚️ Watch App、表盘
    • ☀️ 每日习惯、连胜
    • 🍃 叶子、捐赠、社区
    • ❓ 常见问题
  • 深入每日习惯

    • 每日习惯的背后
    • 💤 睡个好觉
    • 💪 适当锻炼
    • 👟 出门走走
    • 🧹 偶尔忙碌
    • 🧘🏻 专注当下
    • 😮‍💨 关照压力
  • 延展阅读

    • 为什么要记录日常?
    • 温柔的自律,更加可持续
    • 究竟什么是习惯?
    • 关于睡眠,你需要知道的科学
    • 读懂健康数据
  • 服务协议

    • 隐私政策
    • 用户协议

配置

配置文件

VuePress 站点的基本配置文件是 .vuepress/config.js ,但也同样支持 TypeScript 配置文件。你可以使用 .vuepress/config.ts 来得到更好的类型提示。

具体而言,我们对于配置文件的路径有着约定(按照优先顺序):

  • 当前工作目录 cwd 下:
    • vuepress.config.ts
    • vuepress.config.js
    • vuepress.config.mjs
  • 源文件目录 sourceDir 下:
    • .vuepress/config.ts
    • .vuepress/config.js
    • .vuepress/config.mjs

你也可以通过 命令行接口 的 --config 选项来指定配置文件:

vuepress dev docs --config my-config.ts

一个基础的配置文件是这样的:

import { viteBundler } from '@vuepress/bundler-vite'
import { defaultTheme } from '@vuepress/theme-default'
import { defineUserConfig } from 'vuepress'

export default defineUserConfig({
  bundler: viteBundler(),
  theme: defaultTheme(),

  lang: 'zh-CN',
  title: '你好, VuePress !',
  description: '这是我的第一个 VuePress 站点',
})

提示

前往 配置参考 查看所有 VuePress 配置。

客户端配置文件

在大多数情况下,配置文件已经足够帮助你配置好你的 VuePress 站点。不过,有些时候用户们可能希望直接添加一些客户端代码。 VuePress 通过客户端配置文件来支持这种需求:

├─ docs
│  ├─ .vuepress
│  │  ├─ client.js   <--- 客户端配置文件
│  │  └─ config.js   <--- 配置文件
│  └─ README.md
├─ .gitignore
└─ package.json

同样的,我们也有关于客户端配置文件的路径约定(按照优先顺序):

  • 当前工作目录 cwd 下:
    • vuepress.client.ts
    • vuepress.client.js
    • vuepress.client.mjs
  • 源文件目录 sourceDir 下:
    • .vuepress/client.ts
    • .vuepress/client.js
    • .vuepress/client.mjs

一个基础的客户端配置文件是这样的:

import { defineClientConfig } from 'vuepress/client'

export default defineClientConfig({
  enhance({ app, router, siteData }) {},
  setup() {},
  rootComponents: [],
})

提示

和配置文件不同,客户端配置文件不能通过命令行接口的选项来指定。

可以前往 深入 > Cookbook > 客户端配置的使用方法 来了解更多信息。