Skip to content

本站 - 开始

按照 Teek 主题文档的指引,经过以下操作步骤,博客站点很快就可以在本地跑通。

VitePress 安装

在电脑本地硬盘上,创建一个新的项目目录,比如取名叫做 Teek,因为后面将会使用 Teek 这个主题。

sh
pnpm add -D vitepress

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

sh
pnpm vitepress init

Teek 在线安装

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

sh
pnpm install vitepress-theme-teek -D

因为 Teek 还处于开发过程当中,近期会有频繁的版本升级。可以使用包管理命令进行升级:

sh
pnpm up --latest

Teek 引入

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

ts
import Teek from "vitepress-theme-teek";
import "vitepress-theme-teek/index.css";

export default {
  extends: Teek,
};

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

ts
// .vitepress/config.ts
import { defineConfig } from "vitepress";
import { defineTeekConfig } from "vitepress-theme-teek/config";

// Teek 主题配置
const teekConfig = defineTeekConfig({});

// Vitepress 配置
export default defineConfig({
  extends: teekConfig,
  // ...
});

启动运行

下一步,就可以在 docs 根目录下构建包含源文件的各级目录了。如果你之前使用过 VuePress 或 VitePress,直接复制你旧项目内 docs 下的源文件目录,然后进行粘贴即可。

使用以下命令运行它:

sh
pnpm run docs:dev