VitePress搭建静态博客

教程 · 06-05 · 192 人浏览

VitePress是什么?

VitePress是一个静态站点生成器 (SSG),专为构建快速、以内容为中心的站点而设计。简而言之,VitePress获取用Markdown编写的内容,对其应用主题,并生成可以轻松部署到任何地方的静态HTML页面。

VitePress官网:https://vitepress.dev/

演示站点:https://go.aboss.top/

前置准备

  • Node.js 18及以上版本
  • 安装好pnpm:npm i -g pnpm

配置npm镜像源地址:npm config set registry https://registry.npmmirror.com

创建项目

安装VitePress

首先,新建一个项目文件夹VitePress,进入VitePress文件夹根目录后,打开命令提示符窗口,安装VitePress:pnpm add -D vitepress

接着,初始化VitePress:pnpm vitepress init

┌  Welcome to VitePress!
│
◇  Where should VitePress initialize the config?
│  ./docs 如果是构建独立VitePress站点,可选择在当前目录 (./) 中搭建
│
◇  Site title:
│  My Awesome Project
│
◇  Site description:
│  A VitePress Site
│
◇  Theme:
│  Default Theme + Customization 主题建议选第二个
│
◇  Use TypeScript for config and theme files?
│  No 是否使用TypeScript,看个人需求
│
◇  Add VitePress npm scripts to package.json?
│  Yes
│
└  Done! Now run pnpm run docs:dev and start writing.

文件结构

初始化成功后,生成的文件结构是这样的:

.
├── docs
│   ├── .vitepress 最核心目录,用来存放VitePress相关配置文件
│   ├── api-examples.md 示例
│   ├── index.md 主页
│   └── markdown-examples.md 示例
├── node_modules 安装的依赖
├── package.json
└── pnpm-lock.yaml

tree命令:tree -L 2 -a --dirsfirst

启动项目

启动具有即时热更新的本地开发服务器:pnpm run docs:dev

构建项目

运行:pnpm run docs:build

自定义配置

主页

修改页眉页脚:\docs.vitepress\config.mjs文件。

修改主页内容:\docs\index.md文件。

官方文档:https://vitepress.dev/zh/reference/default-theme-home-page

文章页

修改文章页:\docs.vitepress\config.mjs文件。

部署博客

GitHub Pages

部署采用官方的方案,即源码和打包后代码使用同一个仓库,然后使用不同的分支存放不同的代码。

在部署前,先创建一个仓库,例如命名为blog,需要设置为public。接着,在存储库“Settings”中的“Pages”菜单项下,选择“Build and deployment > Source > GitHub Actions”,开启 GitHub Actions 部署支持。

回到本地项目,在项目的 .github/workflows 目录中创建一个名为 deploy.yml 的文件,其中包含内容:

# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程

name: Deploy VitePress site to Pages

on:
  # 在针对 `main` 分支的推送上运行。如果你
  # 使用 `master` 分支作为默认分支,请将其更改为 `master`
  push:
    branches: [main]

  # 允许你从 Actions 选项卡手动运行此工作流程
  workflow_dispatch:

# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# 只允许同时进行一次部署,跳过正在运行和最新队列之间的运行队列
# 但是,不要取消正在进行的运行,因为我们希望允许这些生产部署完成
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  # 构建工作
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0 # 如果未启用 lastUpdated,则不需要
      - uses: pnpm/action-setup@v3 # 如果使用 pnpm,请取消注释
        with:
          version: 9
      # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun,请取消注释
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: pnpm # 或 npm / yarn
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Install dependencies
        run: pnpm install # 或 npm ci / yarn install / bun install
      - name: Build with VitePress
        run: pnpm run docs:build # 或 npm run docs:build / yarn docs:build / bun run docs:build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/.vitepress/dist

  # 部署工作
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    needs: build
    runs-on: ubuntu-latest
    name: Deploy
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

将本地更改推送到 main 分支并等待 GitHub Action 工作流完成,站点将在每次推送到 main 分支时自动部署。

自定义域名

在 docs/public 目录下新增 CNAME 文件,填入你的域名,如:go.aboss.top

然后添加 DNS 解析,创建一条 CNAME 记录,将子域 go.aboss.top 指向 .github.io。

JavaScript
  1. 刘郎 06-05

    VitePress个人觉得只适合练练手

    1. 三毛 (作者)  06-05
      @刘郎

      那有什么推荐使用的吗

Theme Jasmine by Kent Liao