VuePress
首页
  • 基础配置

    • 指南
    • 快速上手
    • 配置
    • 页面
    • Frontmatter
  • 进阶玩法

    • Markdown
    • 静态部署
    • 样式美化
    • DocSearch
    • 插件
    • 组件
    • 更新及卸载
  • 其他站点

    • VitePress文档
    • 劝学录教程
    • 个人主页
Vuepress 2.0.0-rc.14
GitHub
  • 简体中文
  • English
首页
  • 基础配置

    • 指南
    • 快速上手
    • 配置
    • 页面
    • Frontmatter
  • 进阶玩法

    • Markdown
    • 静态部署
    • 样式美化
    • DocSearch
    • 插件
    • 组件
    • 更新及卸载
  • 其他站点

    • VitePress文档
    • 劝学录教程
    • 个人主页
Vuepress 2.0.0-rc.14
GitHub
  • 简体中文
  • English
  • 介绍
    • 前言
  • 基础配置
    • 快速上手
    • 配置
    • 页面
    • Frontmatter
  • 进阶玩法
    • Markdown
    • 静态部署
    • 样式美化
    • DocSearch
    • 插件
    • 组件
    • 更新及卸载
  • 其他站点

    • VitePress文档
    • 劝学录教程
    • 个人主页

配置

最近更新:2024-7-29

打开项目

我们安装了vscode,鼠标右键 通过code打开

鼠标右键没有,是因为你没有安装vscode

目录结构

项目的目录结构应该是这样的

├─ docs           <--- 文档根目录
│  ├─ .vuepress        <--- 配置文件夹
│  │  └─ .cache        <--- 缓存文件
│  │  └─ .temp         <--- 临时文件
│  │  └─ config.ts     <--- 配置文件
│  └─ README.md      <--- 网站首页
├─ node_modules    <--- 依赖目录
├─ .gitignore      <--- git忽略文件
└─ package.json    <--- 依赖管理文件

站点配置

打开 config.ts文件,简单配置一下

你的文件是 config.js ?

JavaScript 格式为 config.js

TypeScript 格式为 config.ts【推荐】

├─ docs
│  ├─ .vuepress
│  │  └─ config.ts   <--- 配置文件
│  └─ README.md
├─ .gitignore
└─ package.json

复制下面代码,粘贴并保存!

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 站点',
})

Ctrl + ` 键,打开vscode内置的终端,运行项目

快捷使用说明

方向键 ↑键 ,可快速调用上次命令

pnpm docs:dev
yarn docs:dev
npm docs:dev

标签栏就有变化了,这样我们基础配置完成了

客户端配置文件(可选)

像我这种小白,基本很难用到了,有些代码基础的可以了解一下

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

步骤也是一样的,在 .vuepress 目录下新建一个 client.ts文件

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

import { defineClientConfig } from 'vuepress/client'

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

在 GitHub 上编辑此页
上次更新:
贡献者: DzPian
上一页
快速上手
下一页
页面