RSDBlog

项目介绍

RSDBlog 是一个基于 VuePress 构建的现代化多人博客平台。它继承了 VitePress 的优秀特性，提供了开箱即用的文档撰写体验和快速的页面响应速度。

主要特性

• ** 极致性能**

  • 基于 Vite 构建，冷启动迅速
  • 自动代码分割
  • 静态站点生成 (SSG)

• ** 优秀的写作体验**

  • 完整的 Markdown 支持
  • 代码高亮
  • 自动生成目录
  • 支持数学公式（KaTeX）
  • Emoji 支持

• ** 美观的界面**

  • 响应式设计
  • 深色模式支持
  • 可自定义主题
  • 支持自定义布局

• ** 搜索功能**

  • 内置全文搜索
  • 支持标签分类
  • 文章归档功能

快速开始

安装步骤

1. 克隆项目

   git clone https://github.com/RobinElysia/MyBlog.git
   cd MyBlog

2. 安装依赖

   npm i

3. 本地开发

   npm docs:dev

4. 构建静态文件

   npm docs:build

5. git工作流

   # 添加修改的文件（. 表示所有，或指定文件名）
   git add .
   
   # 提交到本地
   git commit -m "新功能描述"
   
   # 推送到远程
   git push origin main

目录结构

MyBlog/
 docs/
    .vitepress/
       config.ts          # VitePress 配置文件
       theme/            # 自定义主题
       public/           # 静态资源
    posts/                # 博客文章
    AboutUs.md           # 关于我们
    Link.md              # 友情链接
 package.json
 pnpm-lock.yaml

写作指南

创建新文章

1. 在 \docs/posts\ 目录下创建新的 .md\ 文件
2. 添加文章前置信息（Front Matter）：

---
title: 文章标题
date: YYYY-MM-DD
author: 作者名
tags: 
  - 标签1
  - 标签2
categories: 
  - 分类
description: 文章描述
image: /path/to/cover-image.jpg
sticky: false  # 是否置顶
---

Markdown 增强功能

1. 提示框

::: tip 提示
这是一个提示
:::

::: warning 警告
这是一个警告
:::

::: danger 危险
这是一个危险警告
:::

::: details 详情
这是一个详情块
:::

2. 代码块

export default {
  data () {
    return {
      msg: '高亮第4行'
    }
  }
}

3. 数学公式

$$ E = mc^2$$

配置指南

1. 基础配置

编辑 \docs/.vitepress/config.ts:

import { defineConfig } from 'vitepress'

export default defineConfig({
  title: 'RSDBlog',
  description: 'A VitePress Blog',
  themeConfig: {
    // 站点配置
    nav: [...],
    sidebar: [...],
    // 更多配置...
  }
})

2. 主题定制

1. 创建 \docs/.vitepress/theme/index.ts\
2. 自定义样式和组件

部署指南

GitHub Pages 部署

1. 在 .github\workflows\ 创建 CI/CD 配置文件
2. 配置 GitHub Pages 设置
3. 推送代码触发自动部署

自定义服务器部署

1. 构建项目

   pnpm docs:build

2. 将 \docs/.vitepress/dist\ 目录下的文件部署到服务器
3. 配置 Nginx（示例配置）：

   server {
     listen 80;
     server_name your-domain.com;
     root /path/to/dist;
     index index.html;
     
     location / {
       try_files \ \/ /index.html;
     }
   }

贡献指南

1. Fork 本项目
2. 创建特性分支

   git checkout -b feature/amazing-feature

3. 提交更改

   git commit -m 'feat: add amazing feature'

4. 推送到分支

   git push origin feature/amazing-feature

5. 提交 Pull Request

维护者

• @RobinElysia - 项目负责人

开源协议

本项目采用 MIT 协议，详情请查看 LICENSE 文件。

致谢

• VuePress - 本项目基于 VitePress 构建
• Vue.js - 优秀的前端框架
• 所有贡献者

统计

---

如果这个项目对您有帮助，请考虑给它一个star