search

njpengqc / theme-bluearchive

https://vitepress-theme-bluearchive-njpengqcs-projects.vercel.app
0 stars 0 forks source link

readme

vitepress-theme-bluearchive

logo

BA 主题博客，基于 VitePress，绝赞画饼中

在线预览

preview

功能

画饼

主题配置

首页头图和头像在.vitepress/theme/assets/banner

配置文件在.vitepress/config.mts

export interface ThemeConfig {
  //banner
  name: string // 首页名字
  welcomeText: string // 首页问候语
  motto: string // 首页签名
  social: { icon: string; url: string }[] // 社交平台，icon可选bilibili，github，tw，weibo, wechat, qq, netease_music

  //gitalk配置
  clientID: string
  clientSecret: string
  repo: string
  owner: string
  admin: string[]
}

站点地图配置(SEO 优化)

配置文件在.vitepress/config.mts

  // 生成站点地图
  sitemap: {
    hostname: 'https://vitepress-theme-bluearchive.vercel.app', //替换为你自己的域名
  }

文章配置

---
title: 标题
date: 日期
tags: [标签1, 标签2]
head:
  - - meta
    - name: description
      content: SEO优化描述
  - - meta
    - name: keywords
      content: SEO优化 关键词
---

文章摘要，会在文章列表中显示

---

文章主体内容

快速开始

# pnpm (推荐)
# 安装依赖
pnpm install
# 开发项目
pnpm run dev
# 打包项目
pnpm run build

# yarn
# yarn install
# yarn run dev
# yarn run build

# npm
# npm install
# npm run dev
# npm run build

上线 GitHub Pages 并使用 GitHub Actions 自动构建

本仓库为模板仓库，你可以点击右上角绿色的Use this template按钮，快速创建基于本仓库的 GitHub Pages 仓库。

关于模板仓库，你可以点击从模板创建仓库。

关于 GitHub Pages 仓库，你可以点击GitHub Pages 快速入门。

关于 GitHub Actions，你可以点击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 # 或 pnpm / yarn
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Install dependencies
        run: pnpm install # 或 pnpm install / yarn install / bun install
      - name: Build with VitePress
        run: pnpm run build # 或 pnpm build / yarn build / bun run build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: .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

感谢