E
简单文档
简单文档

安装指南

安装、运行与检查 Estel Docs。

环境要求

建议使用以下环境：

  • Node.js 22 LTS（Dockerfile 使用 Node 22）
  • pnpm 10.x（项目声明为 pnpm@10.13.1）
  • Git
  • Go（仅在开发或部署微信签名服务时需要）
如果只开发 Nuxt 文档与博客站点，不需要安装 Go；只有运行 wechat-sign-server/ 时才需要 Go 环境。

获取项目

git clone https://github.com/estel-li/estel-docs.git
cd estel-docs

如果你使用的是私有仓库或 fork，请将仓库地址替换为自己的地址。

安装依赖

pnpm install

项目使用 .npmrc 配置 pnpm 行为，并通过 lockfile 固定依赖版本。CI 与 Docker 构建均使用 frozen lockfile，因此本地更新依赖后应提交 pnpm-lock.yaml。

启动开发服务

pnpm dev

默认访问：

http://localhost:3000

常用脚本

命令说明
pnpm dev启动 Nuxt 开发服务器。
pnpm lint运行 ESLint。
pnpm typecheck运行 Nuxt 类型检查。
pnpm build构建 SSR 生产产物。
pnpm generate生成静态站点。
pnpm preview本地预览生产构建。

内容开发流程

新增文档

在 content/docs/ 下新增 Markdown 文件：

content/docs/1.简单文档/6.example.md

推荐包含 frontmatter：

---
title: 示例页面
description: 这是一个文档页面示例。
navigation:
  icon: lucide-file-text
---

# 示例页面

这里是正文内容。

新增博客

在 content/blog/ 下新增 Markdown 文件：

content/blog/1.技术栈/1000.example.md

博客文章需要提供 img 与 date 字段：

---
title: 示例博客
description: 这是一篇博客示例。
img: /images/default-blog.jpg
date: 2026-06-13
---

正文内容。

本地检查

提交前建议至少运行：

pnpm lint
pnpm typecheck

如果修改了微信签名服务，还应运行：

cd wechat-sign-server
go test ./...

微信签名服务本地运行

cd wechat-sign-server
cp .env.example .env
go run .

健康检查：

curl http://127.0.0.1:8090/health

签名接口：

curl -X POST http://127.0.0.1:8090/api/wechat/js-sign \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://lijue.net/blog/demo"}'
不要把真实的 WECHAT_APP_SECRET、部署 Token 等密钥提交到仓库。生产环境应使用部署平台 Secret、系统环境变量或 systemd EnvironmentFile 注入。

下一步