快速开始 推荐

版本

建议使用如下包管理器安装 vitepress-theme-teek：

• pnpm推荐
• yarn
• npm

VitePress 安装

有关 VitePress 的安装教程来源于 VitePress 文档。如果安装失败，请阅读 VitePress 文档查看最新的安装教程。

pnpm

pnpmadd-Dvitepress

yarn

yarnadd-Dvitepress

npm

npmadd-Dvitepress

VitePress 附带一个命令行设置向导，可以帮助你构建一个基本项目。安装后，通过运行以下命令启动向导：

pnpm

pnpmvitepressinit

yarn

yarnvitepressinit

npm

npxvitepressinit

将需要回答几个简单的问题：

┌WelcometoVitePress!│◇WhereshouldVitePressinitializetheconfig?│./docs│◇WhereshouldVitePresslookforyourmarkdownfiles?│./docs│◇Sitetitle:│MyAwesomeProject│◇Sitedescription:│AVitePressSite│◇Theme:│DefaultTheme│◇UseTypeScriptforconfigandthemefiles?│Yes│◇AddVitePressnpmscriptstopackage.json?│Yes│◇AddaprefixforVitePressnpmscripts?│Yes│◇PrefixforVitePressnpmscripts:│docs│└Done!Nowrunpnpmrundocs:devandstartwriting.

Teek 在线安装

pnpm

pnpminstallvitepress-theme-teek-D

yarn

yarnaddvitepress-theme-teek-D

npm

npminstallvitepress-theme-teek-D

Teek 引入

根据 VitePress 的要求，需要在 .vitepress/theme/index.ts文件中引入 Teek 主题。如果没有该路径，需要先创建它：

importTeek from"vitepress-theme-teek";import"vitepress-theme-teek/index.css";exportdefault{extends:Teek,};

然后在 .vitepress/config.mts文件中引入 Teek 的配置信息：

import{defineConfig } from"vitepress";import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({});exportdefaultdefineConfig({extends:teekConfig,});

有关 Teek 更多的配置信息，请从 配置简介开始阅读。

启动运行

请查看你的 package.json文件，确保存在下面 npm 脚本：

{"scripts":{"docs:dev":"vitepress dev docs","docs:build":"vitepress build docs","docs:preview":"vitepress preview docs"}}

docs:dev脚本将启动具有即时热更新的本地开发服务器。使用以下命令运行它：

pnpm

pnpmrundocs:dev

yarn

yarndocs:dev

npm

npmrundocs:dev

vitepress dev docs的 docs并不是固定写死的，有三种场景可以进行选择：

• 如果 .vitepress和 Markdown 文档在项目根目录下，则 vitepress dev docs改为 vitepress dev
• 如果 .vitepress和 Markdown 文档在项目 src目录下，则 vitepress dev docs改为 vitepress dev src
• 如果 .vitepress在项目根目录下，Markdown 文档放在 src目录下，则 vitepress dev docs改为 vitepress dev，且需要在 .vitepress/config.mts里配置 srcDir:src，srcDir的作用请看 VitePress - srcDir

总结：VitePress 以 .vitepress所在的目录层级 + srcDir为参照逐层对 Markdown 文档扫描解析。

版本更新

Teek 不定期提供新特性或者修复 Bug，届时只需要更新版本号即可：

pnpm

pnpmaddvitepress-theme-teek@latest-D

yarn

yarnaddvitepress-theme-teek@latest-D

npm

npmaddvitepress-theme-teek@latest-D