zengen 0.2.4 → 0.2.5

package/.zen/src/zh-Hans/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md

@@ -1,77 +0,0 @@
----
-title: ZEN - Markdown 文档站点构建工具
-summary:
-  ZEN 是一个极简的静态站点生成工具，专注于将 Markdown 文件夹构建为 HTML 站点，支持智能导航和 AI
-  驱动的增量翻译，强调内容优先和跨语言支持，无需复杂配置。
-tags:
-  - Markdown
-  - 静态站点生成
-  - AI 翻译
-  - 极简主义
-  - 多语言
-  - 文档工具
-  - ZEN
-inferred_lang: zh-Hans
----
-
-# ZEN - 简洁的 Markdown 文档站点构建工具
-
-> 📖 **阅读提示**: 本 README 为中文版本。英文版本将由 AI 自动翻译生成。
-
-## 项目初衷
-
-### 回归内容
-
-我喜欢沉思，但不想要配置复杂的构建工具，折腾复杂的文档配置，不喜欢复杂的结构。
-
-### 回归母语
-
-生命苦短，我用 AI 翻译。与世界保持连接。
-
-## 基本功能
-
-1. **静态站点生成**
-   - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
-
-2. **智能导航**
-   - 生成站点地图和导航，不需要保持原始的 Markdown 源文件的目录结构
-
-3. **增量 i18n 翻译**
-   - 使用 LLM 进行增量 i18n 翻译，让用户使用母语编写 Markdown，但是用户可以是多语言的
-
-## 设计理念
-
-- **极简主义**: 最少的配置，最大的灵活性
-- **内容优先**: 专注于写作，而不是工具配置
-- **AI 赋能**: 利用 AI 处理翻译和内容组织
-- **跨语言**: 支持多语言内容创作和展示
-
-## 快速开始
-
-### 推荐使用方式
-
-**推荐用户切换到包含 Markdown 文件的目录下，直接使用以下命令开始构建：**
-
-```bash
-npx zengen build
-```
-
-### 其他用法
-
-1. **实时预览（监听文件变化）**：
-
-```bash
-npx zengen build --watch
-```
-
-2. **查看更多参数或帮助**：
-
-```bash
-npx zengen
-```
-
-**注意**：ZEN 强制使用当前目录作为源目录，输出到 `.zen/dist` 目录。不再支持指定源目录和输出目录参数。
-
----
-
-**ZEN** - 让文档回归本质，让写作回归宁静。

package/.zen/src/zh-Hans/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md

@@ -1,189 +0,0 @@
----
-title: ZEN 文档站点最佳实践
-summary: 本文档介绍了使用 ZEN 构建文档站点的最佳实践，涵盖多语言管理、性能优化、部署策略、维护建议、常见问题解决方案和高级技巧，旨在帮助用户高效开发和维护文档。
-tags:
-  - ZEN
-  - 文档站点
-  - 最佳实践
-  - 性能优化
-  - 部署策略
-  - 多语言管理
-  - 维护建议
-inferred_lang: zh-Hans
----
-
-# 最佳实践
-
-本文档介绍使用 ZEN 构建文档站点的最佳实践。
-
-## 多语言管理
-
-### 翻译策略
-
-1. **主语言优先**: 先用母语完整编写文档
-2. **增量翻译**: 每次更新后只翻译修改部分
-3. **术语一致**: 建立术语表保持翻译一致性
-4. **人工校对**: AI 翻译后建议人工校对
-
-## 性能优化
-
-### 构建优化
-
-1. **增量构建**: 使用 `--watch` 模式开发
-2. **缓存利用**: ZEN 会自动缓存处理结果
-3. **并行处理**: 多核 CPU 自动并行处理文件
-
-### 开发工作流
-
-```bash
-# 开发时监听变化
-cd docs
-npx zengen build --watch
-
-# 启动开发服务器
-npx zengen build --watch --serve
-
-# 生产构建
-npx zengen build
-```
-
-## 部署策略
-
-### CI/CD 集成
-
-#### GitHub Actions 示例
-
-```yaml
-name: Build and Deploy Documentation
-on:
-  push:
-    branches: [main]
-    paths:
-      - 'docs/**'
-      - '.github/workflows/docs.yml'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-
-      - name: Build documentation
-        run: |
-          cd docs
-          npx zengen build --base-url /my-docs
-
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/.zen/dist
-```
-
-#### 自定义部署脚本
-
-```bash
-#!/bin/bash
-# deploy-docs.sh
-
-# 切换到文档目录
-cd docs
-
-# 构建文档
-npx zengen build
-
-# 同步到服务器
-rsync -avz .zen/dist/ user@server:/var/www/docs/
-
-# 清理缓存
-rm -rf .zen/cache
-```
-
-### 云部署选项
-
-- **GitHub Pages**: 免费托管文档
-- **Vercel**: 自动部署静态站点
-- **Netlify**: 支持表单处理和重定向
-- **AWS S3 + CloudFront**: 企业级静态托管
-
-## 维护建议
-
-### 定期更新
-
-1. **内容审核**: 每月检查文档准确性
-2. **链接检查**: 定期检查死链
-3. **性能监控**: 监控页面加载速度
-4. **用户反馈**: 收集用户反馈改进文档
-
-### 版本控制
-
-1. **文档版本化**: 与软件版本同步
-2. **变更日志**: 记录文档更新历史
-3. **回滚机制**: 支持快速回滚到旧版本
-
-## 常见问题
-
-### 构建速度慢
-
-**解决方案:**
-
-- 减少不必要的图片和资源
-- 使用 `--watch` 模式进行增量开发
-- 拆分大型文档为多个小文件
-- 禁用不需要的处理器
-
-### 翻译质量不高
-
-**解决方案:**
-
-- 提供上下文给 AI 翻译
-- 建立术语表提高一致性
-- 人工校对关键内容
-- 调整翻译提示词
-
-### 导航结构复杂
-
-**解决方案:**
-
-- 保持扁平化目录结构
-- 使用清晰的标题层级
-- 提供搜索功能
-- 合理使用侧边栏导航
-
-### 内存使用过高
-
-**解决方案:**
-
-- 减少同时处理的文件数量
-- 禁用缓存（不推荐）
-- 增加系统内存
-- 分批处理大型文档
-
-## 高级技巧
-
-### 自定义模板技巧
-
-1. **响应式设计**: 确保模板在移动设备上正常显示
-2. **主题切换**: 实现深色/浅色主题
-3. **代码高亮**: 集成 highlight.js 或其他高亮库
-4. **搜索功能**: 添加客户端搜索
-
-### 集成其他工具
-
-1. **图片优化**: 使用 sharp 或 imagemin 优化图片
-2. **SEO 优化**: 添加 meta 标签和结构化数据
-3. **分析集成**: 集成 Google Analytics 或 Plausible
-4. **CDN 加速**: 使用 CDN 加速静态资源
-
-### 监控和日志
-
-1. **构建日志**: 使用 `--verbose` 查看详细日志
-2. **错误监控**: 设置错误监控和告警
-3. **性能监控**: 监控构建时间和资源使用
-4. **用户分析**: 分析文档使用情况

package/.zen/src/zh-Hans/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md

@@ -1,81 +0,0 @@
----
-title: ZEN - Markdown 文档站点构建工具
-summary: ZEN 是一个简洁的 Markdown 静态站点生成工具，强调内容优先和极简主义，利用 AI 实现智能导航和多语言翻译，帮助用户专注于写作而无需复杂配置。
-tags:
-  - Markdown
-  - 静态站点生成
-  - AI 翻译
-  - 多语言
-  - 极简主义
-  - 文档工具
-  - ZEN
-inferred_lang: zh-Hans
----
-
-# ZEN - 简洁的 Markdown 文档站点构建工具
-
-[简体中文](https://zccz14.github.io/ZEN/zh-Hans) |
-[English](https://zccz14.github.io/ZEN/en-US) |
-[Español](https://zccz14.github.io/ZEN/es-ES) |
-[Português](https://zccz14.github.io/ZEN/pt-PT) |
-[Русский](https://zccz14.github.io/ZEN/ru-RU) |
-[Français](https://zccz14.github.io/ZEN/fr-FR) |
-[日本語](https://zccz14.github.io/ZEN/ja-JP) |
-[한국어](https://zccz14.github.io/ZEN/ko-KR) |
-[Deutsch](https://zccz14.github.io/ZEN/de-DE) |
-
-为什么又搞了个 Markdown 静态站点生成器？我重新思考了 AI 时代下，文档工具可以如何更好地服务于写作者：
-
-- 回归内容：最小化打扰，专注写作
-
-  让文档回归本质，让写作回归宁静。
-
-  其一，我不想做图书管理员。我有时想写下一些内容，但我可能还没有想好它的标题，还没有形成特别的组织。我希望 LLM 会自动帮我生成标题、做摘要、分类、导航等整理工作。
-
-  其二，我的书房必须打扫干净。我不想要配置复杂的构建工具，折腾复杂的文档配置，不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构，我就头疼。现在，ZEN 选择将所有的配置都隐藏到 .zen 目录下，扫到角落里，用户只需要专注于写作内容，其他的交给 ZEN 来处理。其他的目录都是您的写作空间，您可以随意组织您的 Markdown 文件。
-
-- 回归母语：用母语写作，丝滑构建多语言版本
-
-  人生苦短，我懒得翻译。人在使用母语时，才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的，我不想放弃多语言的交流。于是我希望有一个工具，能让我用母语写作，同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说，还得自己维护内容更新，太麻烦了。我选择使用 LLM 来帮我做翻译，省下了我很多时间，并且可以一键完成多国语言翻译。
-
-## 基本功能
-
-1. **静态站点生成**
-   - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
-
-2. **智能导航**
-   - 生成站点地图和导航，不需要保持原始的 Markdown 源文件的目录结构，可以随意移动源文件。
-
-3. **增量 i18n 翻译**
-   - 使用 LLM 进行增量 i18n 翻译，让用户使用母语编写 Markdown，但是用户可以是多语言的
-
-## 设计理念
-
-- **极简主义**: 最少的配置，最大的灵活性
-- **内容优先**: 专注于写作，而不是工具配置
-- **AI 赋能**: 利用 AI 处理翻译和内容组织
-- **跨语言**: 支持多语言内容创作和展示
-
-## 快速开始
-
-### 推荐使用方式
-
-**推荐用户切换到包含 Markdown 文件的目录下，直接使用以下命令开始构建：**
-
-```bash
-# 设置环境变量 (根据您的实际情况修改)
-export OPENAI_API_KEY="sk-xxxxxx"  # 必须：请替换为您的 OpenAI API Key
-export OPENAI_BASE_URL="https://api.openai.com/v1"  # 可选，默认使用 OpenAI 官方 API
-export OPENAI_MODEL="gpt-3.5-turbo"  # 可选，默认使用 gpt-3.5-turbo 模型
-
-# 构建站点，支持多语言翻译
-npx zengen@latest build --lang zh-Hans --lang en-US --verbose
-```
-
-**查看更多参数或帮助**：
-
-```bash
-npx zengen
-```
-
-**注意**：ZEN 强制使用当前目录作为源目录，输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。

package/.zen/src/zh-Hans/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md

@@ -1,55 +0,0 @@
----
-title: ZEN 高级用法指南
-summary:
-  本文档介绍了 ZEN 的高级功能，包括自定义 HTML 模板、配置选项（如源目录、输出目录、模板、基础 URL
-  和多语言支持）以及插件系统，帮助用户扩展和定制 ZEN 工具。
-tags:
-  - ZEN
-  - 高级用法
-  - 自定义模板
-  - 配置选项
-  - 插件系统
-  - 文档生成
-  - 多语言支持
-inferred_lang: zh-Hans
----
-
-# 高级用法
-
-深入介绍 ZEN 的高级功能和配置选项。
-
-## 自定义模板
-
-ZEN 支持自定义 HTML 模板：
-
-```bash
-zengen build --src ./docs --out ./dist --template ./custom-template.html
-```
-
-## 配置选项
-
-可以在 `.zenrc` 文件中配置：
-
-```json
-{
-  "srcDir": "./docs",
-  "outDir": "./dist",
-  "template": "./template.html",
-  "baseUrl": "https://example.com",
-  "i18n": {
-    "sourceLang": "zh-Hans",
-    "targetLangs": ["en-US", "ja-JP"]
-  }
-}
-```
-
-## 插件系统
-
-ZEN 支持插件扩展功能：
-
-```typescript
-interface MarkdownProcessor {
-  beforeParse?(content: string, fileInfo: FileInfo): string | Promise<string>;
-  afterParse?(html: string, fileInfo: FileInfo): string | Promise<string>;
-}
-```

package/.zen/src/zh-Hans/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md

@@ -1,11 +0,0 @@
----
-title: 测试文档
-summary: 这是一个测试文档，内容为空，仅包含标题。
-tags:
-  - 测试
-  - 文档
-  - 示例
-inferred_lang: zh-CN
----
-
-# 测试文档

package/.zen/src/zh-Hans/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md

@@ -1,63 +0,0 @@
----
-title: ZEN 配置指南
-summary:
-  本文档介绍了 ZEN 工具的配置和使用方法，包括基本命令如构建文档、实时预览和启动开发服务器，以及命令行选项如 --watch、--serve
-  和 --port 的详细说明。
-tags:
-  - ZEN
-  - 配置指南
-  - 命令行
-  - 文档构建
-  - 开发服务器
-  - 极简主义
-inferred_lang: zh-Hans
----
-
-# 配置指南
-
-ZEN 的设计理念是极简主义，因此配置非常简单。
-
-## 命令行使用
-
-### 基本命令
-
-```bash
-# 构建文档（推荐使用方式）
-npx zengen build
-
-# 实时预览（监听文件变化）
-npx zengen build --watch
-
-# 启动开发服务器（需要 --watch）
-npx zengen build --watch --serve
-
-# 自定义端口
-npx zengen build --watch --serve --port 8080
-
-# 显示详细日志
-npx zengen build --verbose
-
-# 设置基础 URL
-npx zengen build --base-url /my-docs
-
-# 查看帮助
-npx zengen
-```
-
-**重要说明：**
-
-- ZEN 强制使用当前目录作为源目录，输出到 `.zen/dist` 目录
-- 不再支持通过命令行参数指定源目录和输出目录
-- 使用 `--watch` 模式时，修改文件会自动重建
-
-### 命令行选项
-
-| 选项         | 简写 | 描述                             | 默认值      |
-| ------------ | ---- | -------------------------------- | ----------- |
-| `--watch`    | `-w` | 监听文件变化并自动重建           | `false`     |
-| `--serve`    | `-s` | 启动开发服务器（需要 `--watch`） | `false`     |
-| `--port`     | `-p` | 开发服务器端口                   | `3000`      |
-| `--host`     |      | 开发服务器主机                   | `localhost` |
-| `--verbose`  | `-v` | 显示详细日志                     | `false`     |
-| `--base-url` |      | 站点基础 URL                     | 无          |
-| `--help`     | `-h` | 显示帮助信息                     | 无          |

package/.zen/src/zh-Hans/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md

@@ -1,63 +0,0 @@
----
-title: ZEN - Markdown 文档站点构建工具
-summary: ZEN 是一个极简的 Markdown 静态站点生成工具，强调内容优先，通过隐藏配置和 AI 赋能，让用户专注于母语写作，并支持多语言翻译和智能导航。
-tags:
-  - Markdown
-  - 静态站点生成
-  - AI 翻译
-  - 多语言
-  - 极简主义
-  - 内容优先
-  - 文档工具
-inferred_lang: zh-Hans
----
-
-# ZEN - 简洁的 Markdown 文档站点构建工具
-
-[简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
-
-为什么又搞了个 Markdown 静态站点生成器？
-
-- 回归内容：最小化打扰，让您专注写作
-
-  让文档回归本质，让写作回归宁静。我不想要配置复杂的构建工具，折腾复杂的文档配置，不喜欢复杂的结构。每次我看到 Docusaurus、VuePress、Astro 这些工具的配置文件和项目结构，我就头疼。现在，ZEN 选择将所有的配置都隐藏到 .zen 目录下，扫到角落里，用户只需要专注于写作内容，其他的交给 ZEN 来处理。其他的目录都是您的写作空间，您可以随意组织您的 Markdown 文件。LLM 还会自动帮您生成标题、做摘要、分类、生成导航等工作。您真的只需要专注于写作。
-
-- 回归母语：仅用母语写作，丝滑构建多语言版本
-
-  人生苦短，我懒得翻译。人在使用母语时，才是最能发挥自身思考深度的。但同时与世界保持连接又是必要的，我不想放弃多语言的交流。于是我希望有一个工具，能让我用母语写作，同时又能让更多人看到我的内容。现在的 i18n 需要自己翻译不说，还得自己维护内容更新，太麻烦了。我选择使用 LLM 来帮我做翻译，省下了我很多时间，并且可以一键完成多国语言翻译。
-
-## 基本功能
-
-1. **静态站点生成**
-   - 将任意一个包含 Markdown 的文件夹构建成一个静态 HTML 站点
-
-2. **智能导航**
-   - 生成站点地图和导航，不需要保持原始的 Markdown 源文件的目录结构
-
-3. **增量 i18n 翻译**
-   - 使用 LLM 进行增量 i18n 翻译，让用户使用母语编写 Markdown，但是用户可以是多语言的
-
-## 设计理念
-
-- **极简主义**: 最少的配置，最大的灵活性
-- **内容优先**: 专注于写作，而不是工具配置
-- **AI 赋能**: 利用 AI 处理翻译和内容组织
-- **跨语言**: 支持多语言内容创作和展示
-
-## 快速开始
-
-### 推荐使用方式
-
-**推荐用户切换到包含 Markdown 文件的目录下，直接使用以下命令开始构建：**
-
-```bash
-npx zengen build
-```
-
-**查看更多参数或帮助**：
-
-```bash
-npx zengen
-```
-
-**注意**：ZEN 强制使用当前目录作为源目录，输出到 `.zen/dist` 目录。不支持指定源目录和输出目录参数。

package/.zen/src/zh-Hans/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md

@@ -1,40 +0,0 @@
----
-title: 快速开始指南
-summary: 本文档介绍如何快速开始使用 ZEN 文档生成器，包括安装步骤、基本用法和主要特性。
-tags:
-  - ZEN 文档生成器
-  - 快速开始
-  - 安装
-  - 基本用法
-  - 特性
-  - Markdown
-  - 构建命令
-inferred_lang: zh-Hans
----
-
-# 快速开始指南
-
-本文档介绍如何快速开始使用 ZEN 文档生成器。
-
-## 安装
-
-```bash
-npm install -g zengen
-```
-
-## 基本用法
-
-1. 创建文档目录
-2. 编写 Markdown 文件
-3. 运行构建命令
-
-```bash
-zengen build --src ./docs --out ./dist
-```
-
-## 特性
-
-- 极简配置
-- 内置响应式模板
-- AI 辅助元数据提取
-- 多语言支持

package/.zen/src/zh-Hans/fdfca9b960d0eaa8b2b96fe988ead7481d2c0b16f66ebc94fb477139b4178cdc.md

@@ -1,65 +0,0 @@
----
-title: ZEN 文档站点示例
-summary: 介绍 ZEN 文档构建工具，一个极简主义的 Markdown 文档站点生成器，包括特性、快速开始指南、代码示例和下一步学习资源。
-tags:
-  - ZEN
-  - 文档构建工具
-  - Markdown
-  - 站点生成器
-  - 快速开始
-  - 代码示例
-  - 多语言支持
-inferred_lang: zh-Hans
----
-
-# ZEN 文档站点示例
-
-欢迎使用 ZEN 文档构建工具！这是一个极简主义的 Markdown 文档站点生成器。
-
-## 特性
-
-- **极简配置**: 无需复杂的配置文件
-- **内容优先**: 专注于写作，而不是工具配置
-- **智能导航**: 自动生成站点地图和导航
-- **多语言支持**: 支持增量 i18n 翻译
-
-## 快速开始
-
-```bash
-# 使用 npx 构建文档（推荐）
-npx zengen build
-
-# 实时预览（监听文件变化）
-npx zengen build --watch
-
-# 查看更多参数或帮助
-npx zengen
-```
-
-**注意**：ZEN 强制使用当前目录作为源目录，输出到 `.zen/dist` 目录。不再支持指定源目录和输出目录参数。
-
-## 代码示例
-
-```javascript
-// 这是一个 JavaScript 示例
-const zen = require('zengen');
-
-async function buildDocs() {
-  await zen.build({
-    // ZEN 现在强制使用当前目录作为源目录
-    // 输出到 .zen/dist 目录
-  });
-}
-```
-
-```python
-# 这是一个 Python 示例
-def hello_world():
-    print("Hello from ZEN!")
-```
-
-## 下一步
-
-1. 阅读 [API 文档](./api.md)
-2. 查看 [配置指南](./config.md)
-3. 学习 [最佳实践](./best-practices.md)