# 🚀️ Quick Start

## 1. 安装

- 首先，请确保你已经安装了 [Node.js](https://nodejs.org/en/) 和 [npm](https://www.npmjs.com/)( >= 8.0.0)。
- 更加推荐使用 [pnpm](https://pnpm.js.org/) 作为包管理器。

```bash
# 创建目录，将 my-docs 替换成你的项目名称
mkdir my-docs && cd my-docs

# 使用 pnpm
pnpm install beaver-ssg
# 或者使用 npm
# npm install beaver-ssg
```

## 2. 配置 

### 2.1 初始化
- 在项目根目录创建 `docs` 目录，该目录用于放置 `.md` 文件和资源文件、配置项等。

```bash
# 创建 docs 目录
mkdir docs

# 创建 markdown 目录和 public 目录以及 .beaver 目录
mkdir -p docs/markdown docs/public docs/.beaver

```

- 成功创建之后，`docs` 目录结构如下：

```text
./docs
├── .beaver   # 放置项目的配置文件
├── markdown  # 放置需要渲染的文档文件
└── public    # 放置图片等资源文件
```

### 2.2 配置文件