MaraPython

Appearance

Alowree Xu2025-04-10
638
2.5m
Get...

本站-开始 ​

本指南将引导您如何在本地环境中快速启动、构建和预览本站。在开始之前，请确保您的电脑已经安装了以下必备环境：

  • Node.js: 版本需为 ^18.0.0 或 >=20.0.0。您可以从 Node.js 官网 下载安装。
  • pnpm: 一个快速、高效的包管理工具。您可以通过 npm install -g pnpm 进行全局安装，详情请参考 pnpm 官方文档。

下面我们从零开始，一步一步进行构建。

本地运行 ​

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

命令成功运行后，您会在终端看到类似下面的输出：

sh
vitepress v1.6.3
➜  Local:   http://localhost:5173/
➜  Network: use --host to expose
➜  press h to show help

现在，您可以在浏览器中打开 http://localhost:5173/ 地址，开始对本地站点进行访问和预览了。

远程推送 ​

这里介绍如何将本地项目仓库推送至 GitHub 的远程仓库。

Vercel 部署 ​

这里介绍如何在 Vercel 创建新一个新项目，并从 GitHub 拉取仓库内容，生成静态站点

克隆或拉取 ​

如何快速将位于远程仓库的项目快速部署到新的电脑。

最近更新