Skip to content

Commit

Permalink
docs: 从自述文件中分离出贡献指南
Browse files Browse the repository at this point in the history
  • Loading branch information
HowieHz committed Dec 12, 2024
1 parent bcb8278 commit f4e42e2
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 80 deletions.
83 changes: 83 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# 贡献指南

## 项目结构

- 待补充

## 开发指南

首先请确保你的编辑器支持 EditorConfig,这保证了项目代码格式的统一。

### 部署开发环境

#### 安装 pnpm

需要提前[安装 Node.js](https://nodejs.org/zh-cn/download/package-manager),然后运行以下指令安装 pnpm

```bash
npm install -g pnpm
```

### 开发前准备

#### 下载项目源码,并进入到项目根目录

```bash
git clone https://github.com/HowieHz/halo-theme-higan-hz && cd halo-theme-higan-hz/
```

#### 安装项目依赖

之后在项目根目录运行以下指令完成依赖的安装

```bash
pnpm install
```

### 开发主题

开发时在项目根目录运行运行以下指令可实时渲染修改

```bash
pnpm dev
```

### 开发之后

#### 求疵

开发完成后请运行以下的指令进行检查(请确保无 error)

```bash
pnpm lint
```

#### 格式化代码

提交前请运行以下的指令的指令格式化代码

```bash
pnpm format
```

#### 构建主题

最后在提交前请不要忘记运行以下的指令构建主题

```bash
pnpm build
```

#### 其他 NPM 脚本的作用

在 .\tmp\ 目录输出未压缩的样式文件,便于追踪问题

```bash
pnpm dev-build
```

<!-- #### 打包主题
```bash
pnpm release
``` -->
80 changes: 0 additions & 80 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,6 @@
- [设置内容仅在浅色/深色模式下显示](#设置内容仅在浅色深色模式下显示)
- [使用默认编辑器](#使用默认编辑器-1)
- [使用 Vditor 编辑器](#使用-vditor-编辑器-1)
- [进行此项目的开发](#进行此项目的开发)
- [开发前准备](#开发前准备)
- [安装 pnpm](#安装-pnpm)
- [安装项目依赖](#安装项目依赖)
- [开发主题](#开发主题)
- [开发之后](#开发之后)
- [求疵](#求疵)
- [格式化代码](#格式化代码)
- [构建主题](#构建主题)
- [其他 NPM 脚本的作用](#其他-npm-脚本的作用)
- [版本适用说明](#版本适用说明)
- [TODO](#todo)
- [Lighthouse](#lighthouse)
Expand Down Expand Up @@ -744,76 +734,6 @@ title: [[图表标题]]
</div>
```

## 进行此项目的开发

首先请确保你的编辑器支持 EditorConfig,这保证了项目代码格式的统一。

### 开发前准备

#### 安装 pnpm

需要提前安装 Node.js,然后运行以下指令安装 pnpm

```bash
npm install -g pnpm
```

#### 安装项目依赖

之后在项目根目录运行以下指令完成依赖的安装

```bash
pnpm install
```

### 开发主题

开发时在项目根目录运行运行以下指令可实时渲染修改

```bash
pnpm dev
```

### 开发之后

#### 求疵

开发完成后请运行以下的指令进行检查(请确保无 error)

```bash
pnpm lint
```

#### 格式化代码

提交前请运行以下的指令的指令格式化代码

```bash
pnpm format
```

#### 构建主题

最后在提交前请不要忘记运行以下的指令构建主题

```bash
pnpm build
```

#### 其他 NPM 脚本的作用

在 .\tmp\ 目录输出未压缩的样式文件,便于追踪问题

```bash
pnpm dev-build
```

<!-- #### 打包主题
```bash
pnpm release
``` -->

## 版本适用说明

当前 main 分支适用于 Halo 2.0 版本
Expand Down

0 comments on commit f4e42e2

Please sign in to comment.