zengen 0.2.4 → 0.2.5

package/.zen/src/en-US/04319611d7cde718d0e82da8e034e04b15fb3bb37c3784d8f7313577c5178b06.md

@@ -1,73 +0,0 @@
----
-title: ZEN - Markdown Documentation Site Builder
-summary: ZEN is a minimalist Markdown static site generator focused on content writing. It leverages AI for translation and navigation, supports multilingual builds, and requires no complex configuration.
-tags:
-  - Markdown
-  - Static Site Generator
-  - AI Translation
-  - Multilingual
-  - Minimalism
-  - Documentation Tool
-  - ZEN
-inferred_lang: en-US
----
-
-# ZEN - A Minimalist Markdown Documentation Site Builder
-
-[简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
-
-Why create another Markdown static site generator? I've been rethinking how documentation tools can better serve writers in the AI era:
-
-- **Return to Content**: Minimize distractions, focus on writing.
-
-  Let documentation return to its essence, and let writing return to tranquility.
-
-  First, I don't want to be a librarian. Sometimes I want to jot down some content, but I might not have thought of a title yet, or haven't formed a specific structure. I hope LLMs will automatically help me generate titles, summaries, categorize, and organize navigation.
-
-  Second, my study must be kept tidy. I don't want complex build tools, fiddling with intricate documentation configurations, or complicated structures. Every time I see the configuration files and project structures of tools like Docusaurus, VuePress, or Astro, my head hurts. Now, ZEN chooses to hide all configurations in the `.zen` directory, swept into a corner. Users only need to focus on writing content; everything else is handled by ZEN. All other directories are your writing space; you can organize your Markdown files however you like.
-
-- **Return to Native Language**: Write in your native language, build multilingual versions seamlessly.
-
-  Life is short; I'm too lazy to translate. People can best express the depth of their thinking when using their native language. Yet, staying connected to the world is necessary; I don't want to give up multilingual communication. So, I wanted a tool that allows me to write in my native language while enabling more people to see my content. Current i18n solutions not only require manual translation but also self-maintenance of content updates, which is too troublesome. I choose to use LLMs to handle translation for me, saving a lot of time and enabling one-click translation into multiple languages.
-
-## Core Features
-
-1. **Static Site Generation**
-   - Build any folder containing Markdown files into a static HTML site.
-
-2. **Intelligent Navigation**
-   - Generate site maps and navigation. You don't need to maintain the original directory structure of the Markdown source files; you can move source files around freely.
-
-3. **Incremental i18n Translation**
-   - Use LLMs for incremental i18n translation, allowing users to write Markdown in their native language while the site can be multilingual.
-
-## Design Philosophy
-
-- **Minimalism**: Minimal configuration, maximum flexibility.
-- **Content First**: Focus on writing, not tool configuration.
-- **AI-Powered**: Leverage AI for translation and content organization.
-- **Cross-Language**: Support multilingual content creation and display.
-
-## Quick Start
-
-### Recommended Usage
-
-**It is recommended to switch to the directory containing your Markdown files and directly use the following command to start building:**
-
-```bash
-# Set environment variables (modify according to your actual situation)
-export OPENAI_API_KEY="sk-xxxxxx"  # Required: Replace with your OpenAI API Key
-export OPENAI_BASE_URL="https://api.openai.com/v1"  # Optional, defaults to the official OpenAI API
-export OPENAI_MODEL="gpt-3.5-turbo"  # Optional, defaults to the gpt-3.5-turbo model
-
-# Build the site with support for multilingual translation
-npx zengen@latest build --lang zh-Hans --lang en-US --verbose
-```
-
-**To view more parameters or help**:
-
-```bash
-npx zengen
-```
-
-**Note**: ZEN enforces using the current directory as the source directory and outputs to the `.zen/dist` directory. It does not support specifying source and output directory parameters.

package/.zen/src/en-US/1b798c44a4f353e47296ca83d5905e37e6aba3e90bbd9bc3b3d34fc12059a2ca.md

@@ -1,75 +0,0 @@
----
-title: ZEN - Markdown Documentation Site Builder
-summary: ZEN is a minimalist static site generator focused on building HTML sites from Markdown folders. It supports intelligent navigation and AI-powered incremental translation, emphasizing content-first and cross-language support without complex configuration.
-tags:
-  - Markdown
-  - Static Site Generation
-  - AI Translation
-  - Minimalism
-  - Multilingual
-  - Documentation Tool
-  - ZEN
-inferred_lang: en-US
----
-
-# ZEN - A Concise Markdown Documentation Site Builder
-
-> 📖 **Reading Note**: This README is the Chinese version. The English version will be automatically generated by AI translation.
-
-## Project Motivation
-
-### Return to Content
-
-I enjoy contemplation but dislike complex build tools, fiddling with intricate documentation configurations, and complicated structures.
-
-### Return to Native Language
-
-Life is short, I use AI translation. Stay connected with the world.
-
-## Core Features
-
-1. **Static Site Generation**
-   - Build a static HTML site from any folder containing Markdown files.
-
-2. **Intelligent Navigation**
-   - Generate site maps and navigation without needing to preserve the original directory structure of the Markdown source files.
-
-3. **Incremental i18n Translation**
-   - Use LLM for incremental i18n translation, allowing users to write Markdown in their native language while supporting multilingual audiences.
-
-## Design Philosophy
-
-- **Minimalism**: Minimal configuration, maximum flexibility.
-- **Content-First**: Focus on writing, not tool configuration.
-- **AI-Powered**: Leverage AI for translation and content organization.
-- **Cross-Language**: Support multilingual content creation and display.
-
-## Quick Start
-
-### Recommended Usage
-
-**It is recommended that users switch to the directory containing Markdown files and directly use the following command to start building:**
-
-```bash
-npx zengen build
-```
-
-### Other Usages
-
-1. **Live Preview (Watch for file changes)**:
-
-```bash
-npx zengen build --watch
-```
-
-2. **View more parameters or help**:
-
-```bash
-npx zengen
-```
-
-**Note**: ZEN enforces using the current directory as the source directory and outputs to the `.zen/dist` directory. Specifying source and output directory parameters is no longer supported.
-
----
-
-**ZEN** - Let documentation return to its essence, let writing return to tranquility.

package/.zen/src/en-US/1e96be58d76c60056b708eb5bd8b8b81d7b5845d9cfe0b879d85068a5f11df3a.md

@@ -1,189 +0,0 @@
----
-title: ZEN Documentation Site Best Practices
-summary: This document introduces best practices for building documentation sites using ZEN, covering multilingual management, performance optimization, deployment strategies, maintenance recommendations, common issue solutions, and advanced techniques, aiming to help users efficiently develop and maintain documentation.
-tags:
-  - ZEN
-  - Documentation Site
-  - Best Practices
-  - Performance Optimization
-  - Deployment Strategy
-  - Multilingual Management
-  - Maintenance Recommendations
-inferred_lang: en-US
----
-
-# Best Practices
-
-This document introduces best practices for building documentation sites using ZEN.
-
-## Multilingual Management
-
-### Translation Strategy
-
-1.  **Primary Language First**: Write the complete documentation in your native language first.
-2.  **Incremental Translation**: Only translate modified parts after each update.
-3.  **Terminology Consistency**: Create a glossary to maintain translation consistency.
-4.  **Human Review**: It is recommended to perform human review after AI translation.
-
-## Performance Optimization
-
-### Build Optimization
-
-1.  **Incremental Builds**: Use `--watch` mode for development.
-2.  **Cache Utilization**: ZEN automatically caches processing results.
-3.  **Parallel Processing**: Files are automatically processed in parallel on multi-core CPUs.
-
-### Development Workflow
-
-```bash
-# Watch for changes during development
-cd docs
-npx zengen build --watch
-
-# Start development server
-npx zengen build --watch --serve
-
-# Production build
-npx zengen build
-```
-
-## Deployment Strategy
-
-### CI/CD Integration
-
-#### GitHub Actions Example
-
-```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
-```
-
-#### Custom Deployment Script
-
-```bash
-#!/bin/bash
-# deploy-docs.sh
-
-# Switch to the documentation directory
-cd docs
-
-# Build documentation
-npx zengen build
-
-# Sync to server
-rsync -avz .zen/dist/ user@server:/var/www/docs/
-
-# Clean cache
-rm -rf .zen/cache
-```
-
-### Cloud Deployment Options
-
-- **GitHub Pages**: Free hosting for documentation.
-- **Vercel**: Automatic deployment for static sites.
-- **Netlify**: Supports form handling and redirects.
-- **AWS S3 + CloudFront**: Enterprise-grade static hosting.
-
-## Maintenance Recommendations
-
-### Regular Updates
-
-1.  **Content Review**: Check documentation accuracy monthly.
-2.  **Link Checking**: Regularly check for broken links.
-3.  **Performance Monitoring**: Monitor page load speed.
-4.  **User Feedback**: Collect user feedback to improve documentation.
-
-### Version Control
-
-1.  **Documentation Versioning**: Synchronize with software versions.
-2.  **Changelog**: Record documentation update history.
-3.  **Rollback Mechanism**: Support quick rollback to previous versions.
-
-## Common Issues
-
-### Slow Build Speed
-
-**Solutions:**
-
-- Reduce unnecessary images and resources.
-- Use `--watch` mode for incremental development.
-- Split large documents into multiple smaller files.
-- Disable unnecessary processors.
-
-### Poor Translation Quality
-
-**Solutions:**
-
-- Provide context to the AI translator.
-- Create a glossary to improve consistency.
-- Perform human review for critical content.
-- Adjust translation prompts.
-
-### Complex Navigation Structure
-
-**Solutions:**
-
-- Maintain a flat directory structure.
-- Use clear heading hierarchies.
-- Provide search functionality.
-- Use sidebar navigation appropriately.
-
-### High Memory Usage
-
-**Solutions:**
-
-- Reduce the number of files processed simultaneously.
-- Disable caching (not recommended).
-- Increase system memory.
-- Process large documents in batches.
-
-## Advanced Techniques
-
-### Custom Template Techniques
-
-1.  **Responsive Design**: Ensure the template displays correctly on mobile devices.
-2.  **Theme Switching**: Implement dark/light themes.
-3.  **Code Highlighting**: Integrate highlight.js or other highlighting libraries.
-4.  **Search Functionality**: Add client-side search.
-
-### Integrating Other Tools
-
-1.  **Image Optimization**: Use sharp or imagemin to optimize images.
-2.  **SEO Optimization**: Add meta tags and structured data.
-3.  **Analytics Integration**: Integrate Google Analytics or Plausible.
-4.  **CDN Acceleration**: Use a CDN to accelerate static resources.
-
-### Monitoring and Logging
-
-1.  **Build Logs**: Use `--verbose` to view detailed logs.
-2.  **Error Monitoring**: Set up error monitoring and alerts.
-3.  **Performance Monitoring**: Monitor build time and resource usage.
-4.  **User Analytics**: Analyze documentation usage.

package/.zen/src/en-US/48eb2ad3e174cd06ed16c959fa58e0381dbc4a4147fa3456b21eea2b3d67c329.md

@@ -1,81 +0,0 @@
----
-title: ZEN - Markdown Documentation Site Builder
-summary: ZEN is a clean Markdown static site generator that emphasizes content-first and minimalism. It leverages AI for intelligent navigation and multilingual translation, helping users focus on writing without complex configurations.
-tags:
-  - Markdown
-  - Static Site Generator
-  - AI Translation
-  - Multilingual
-  - Minimalism
-  - Documentation Tool
-  - ZEN
-inferred_lang: en-US
----
-
-# ZEN - A Clean Markdown Documentation Site Builder
-
-[简体中文](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) |
-
-Why create another Markdown static site generator? I've rethought how documentation tools can better serve writers in the AI era:
-
-- **Return to Content**: Minimize distractions, focus on writing
-
-  Let documentation return to its essence, let writing return to tranquility.
-
-  First, I don't want to be a librarian. Sometimes I want to jot down some content, but I might not have thought of its title yet, or haven't formed a specific organization. I hope LLMs will automatically help me generate titles, create summaries, categorize, navigate, and handle other organizational tasks.
-
-  Second, my study must be kept clean. I don't want complex build tools, fiddling with intricate documentation configurations, or complicated structures. Every time I see the configuration files and project structures of tools like Docusaurus, VuePress, or Astro, I get a headache. Now, ZEN chooses to hide all configurations in the `.zen` directory, sweeping them into a corner. Users only need to focus on writing content; everything else is handled by ZEN. All other directories are your writing space; you can organize your Markdown files however you like.
-
-- **Return to Native Language**: Write in your native language, smoothly build multilingual versions
-
-  Life is short; I'm too lazy to translate. People can best express the depth of their thinking when using their native language. But staying connected with the world is also necessary; I don't want to give up multilingual communication. So, I want a tool that lets me write in my native language while allowing more people to see my content. Current i18n solutions not only require you to translate yourself but also maintain content updates, which is too troublesome. I choose to use LLMs to help with translation, saving me a lot of time and enabling one-click multilingual translation.
-
-## Core Features
-
-1. **Static Site Generation**
-   - Build any folder containing Markdown files into a static HTML site.
-
-2. **Intelligent Navigation**
-   - Generate site maps and navigation. You don't need to maintain the original directory structure of the Markdown source files; you can move source files around freely.
-
-3. **Incremental i18n Translation**
-   - Use LLMs for incremental i18n translation, allowing users to write Markdown in their native language while the site can be multilingual.
-
-## Design Philosophy
-
-- **Minimalism**: Minimal configuration, maximum flexibility.
-- **Content-First**: Focus on writing, not tool configuration.
-- **AI-Powered**: Leverage AI for translation and content organization.
-- **Cross-Language**: Support multilingual content creation and display.
-
-## Quick Start
-
-### Recommended Usage
-
-**It is recommended that users switch to the directory containing Markdown files and directly use the following command to start building:**
-
-```bash
-# Set environment variables (modify according to your actual situation)
-export OPENAI_API_KEY="sk-xxxxxx"  # Required: Please replace with your OpenAI API Key
-export OPENAI_BASE_URL="https://api.openai.com/v1"  # Optional, defaults to the official OpenAI API
-export OPENAI_MODEL="gpt-3.5-turbo"  # Optional, defaults to the gpt-3.5-turbo model
-
-# Build the site, supporting multilingual translation
-npx zengen@latest build --lang zh-Hans --lang en-US --verbose
-```
-
-**View more parameters or help**:
-
-```bash
-npx zengen
-```
-
-**Note**: ZEN enforces using the current directory as the source directory and outputs to the `.zen/dist` directory. It does not support specifying source and output directory parameters.

package/.zen/src/en-US/5ec990146b35e00de2630559126ee07f7cdcddeb23b0e8cab3d85b4181353e26.md

@@ -1,53 +0,0 @@
----
-title: ZEN Advanced Usage Guide
-summary: This document introduces the advanced features of ZEN, including custom HTML templates, configuration options (such as source directory, output directory, template, base URL, and multilingual support), and the plugin system, helping users extend and customize the ZEN tool.
-tags:
-  - ZEN
-  - Advanced Usage
-  - Custom Templates
-  - Configuration Options
-  - Plugin System
-  - Documentation Generation
-  - Multilingual Support
-inferred_lang: en-US
----
-
-# Advanced Usage
-
-An in-depth introduction to the advanced features and configuration options of ZEN.
-
-## Custom Templates
-
-ZEN supports custom HTML templates:
-
-```bash
-zengen build --src ./docs --out ./dist --template ./custom-template.html
-```
-
-## Configuration Options
-
-Can be configured in the `.zenrc` file:
-
-```json
-{
-  "srcDir": "./docs",
-  "outDir": "./dist",
-  "template": "./template.html",
-  "baseUrl": "https://example.com",
-  "i18n": {
-    "sourceLang": "zh-Hans",
-    "targetLangs": ["en-US", "ja-JP"]
-  }
-}
-```
-
-## Plugin System
-
-ZEN supports plugin extensions:
-
-```typescript
-interface MarkdownProcessor {
-  beforeParse?(content: string, fileInfo: FileInfo): string | Promise<string>;
-  afterParse?(html: string, fileInfo: FileInfo): string | Promise<string>;
-}
-```

package/.zen/src/en-US/6124ea88edec5bde737b26b21f71ecfeffe4e73151784856edf813ee231a4baa.md

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

package/.zen/src/en-US/80ae9bed74fc6348a7c1fe9f33e86b65f5d919169721f77bcf0e1bc29fbdb4f9.md

@@ -1,61 +0,0 @@
----
-title: ZEN Configuration Guide
-summary: This document introduces the configuration and usage of the ZEN tool, including basic commands such as building documentation, live preview, and starting a development server, as well as detailed explanations of command-line options like --watch, --serve, and --port.
-tags:
-  - ZEN
-  - Configuration Guide
-  - Command Line
-  - Documentation Build
-  - Development Server
-  - Minimalism
-inferred_lang: en-US
----
-
-# Configuration Guide
-
-ZEN is designed with a minimalist philosophy, making its configuration very simple.
-
-## Command Line Usage
-
-### Basic Commands
-
-```bash
-# Build documentation (recommended usage)
-npx zengen build
-
-# Live preview (watch for file changes)
-npx zengen build --watch
-
-# Start development server (requires --watch)
-npx zengen build --watch --serve
-
-# Custom port
-npx zengen build --watch --serve --port 8080
-
-# Show verbose logs
-npx zengen build --verbose
-
-# Set base URL
-npx zengen build --base-url /my-docs
-
-# View help
-npx zengen
-```
-
-**Important Notes:**
-
-- ZEN enforces the use of the current directory as the source directory, outputting to the `.zen/dist` directory.
-- Specifying source and output directories via command-line arguments is no longer supported.
-- When using `--watch` mode, modifying files triggers automatic rebuilds.
-
-### Command Line Options
-
-| Option       | Short | Description                                      | Default     |
-| ------------ | ----- | ------------------------------------------------ | ----------- |
-| `--watch`    | `-w`  | Watch for file changes and rebuild automatically | `false`     |
-| `--serve`    | `-s`  | Start development server (requires `--watch`)    | `false`     |
-| `--port`     | `-p`  | Development server port                          | `3000`      |
-| `--host`     |       | Development server host                          | `localhost` |
-| `--verbose`  | `-v`  | Show verbose logs                                | `false`     |
-| `--base-url` |       | Site base URL                                    | None        |
-| `--help`     | `-h`  | Show help information                            | None        |

package/.zen/src/en-US/afbf4998656c97181d0edc711e388ad11e0f08f5c6f329861327202462a3a34a.md

@@ -1,63 +0,0 @@
----
-title: ZEN - Markdown Documentation Site Builder
-summary: ZEN is a minimalist Markdown static site generator that emphasizes content-first, hides configuration, and leverages AI to empower users to focus on writing in their native language, while supporting multilingual translation and intelligent navigation.
-tags:
-  - Markdown
-  - Static Site Generation
-  - AI Translation
-  - Multilingual
-  - Minimalism
-  - Content-First
-  - Documentation Tool
-inferred_lang: en-US
----
-
-# ZEN - A Minimalist Markdown Documentation Site Builder
-
-[简体中文](https://zccz14.github.io/ZEN/zh-Hans) | [English](https://zccz14.github.io/ZEN/en-US)
-
-Why create another Markdown static site generator?
-
-- **Return to Content**: Minimize distractions, let you focus on writing
-
-  Let documentation return to its essence, let writing return to tranquility. I don't want complex build tools with complicated configurations, I dislike fiddling with intricate documentation setups and convoluted structures. Every time I see the configuration files and project structures of tools like Docusaurus, VuePress, or Astro, my head hurts. Now, ZEN chooses to hide all configuration in the `.zen` directory, sweeping it into a corner. Users only need to focus on writing content; ZEN handles the rest. All other directories are your writing space; you can organize your Markdown files however you like. LLMs will automatically help you generate titles, create summaries, categorize, and generate navigation. You really only need to focus on writing.
-
-- **Return to Native Language**: Write only in your native language, smoothly build multilingual versions
-
-  Life is short, I'm too lazy to translate. People can best express the depth of their thinking when using their native language. But staying connected to the world is also necessary; I don't want to give up multilingual communication. So I wanted a tool that allows me to write in my native language while also letting more people see my content. Current i18n solutions not only require you to translate yourself but also to maintain content updates, which is too troublesome. I choose to use LLMs to handle translation for me, saving me a lot of time and enabling one-click translation into multiple languages.
-
-## Core Features
-
-1. **Static Site Generation**
-   - Build any folder containing Markdown files into a static HTML site.
-
-2. **Intelligent Navigation**
-   - Generate site maps and navigation without needing to maintain the original directory structure of the Markdown source files.
-
-3. **Incremental i18n Translation**
-   - Use LLMs for incremental i18n translation, allowing users to write Markdown in their native language while the audience can be multilingual.
-
-## Design Philosophy
-
-- **Minimalism**: Minimal configuration, maximum flexibility.
-- **Content-First**: Focus on writing, not tool configuration.
-- **AI-Powered**: Leverage AI for translation and content organization.
-- **Cross-Language**: Support multilingual content creation and display.
-
-## Quick Start
-
-### Recommended Usage
-
-**It is recommended that users switch to the directory containing their Markdown files and directly use the following command to start building:**
-
-```bash
-npx zengen build
-```
-
-**To view more parameters or help:**
-
-```bash
-npx zengen
-```
-
-**Note**: ZEN enforces using the current directory as the source directory and outputs to the `.zen/dist` directory. It does not support specifying source and output directory parameters.

package/.zen/src/en-US/f0c2799126931ccd113a0c45b1e623870b0d4f4f400becf6dd877da8f1011517.md

@@ -1,40 +0,0 @@
----
-title: Quick Start Guide
-summary: This document introduces how to quickly get started with the ZEN documentation generator, including installation steps, basic usage, and main features.
-tags:
-  - ZEN Documentation Generator
-  - Quick Start
-  - Installation
-  - Basic Usage
-  - Features
-  - Markdown
-  - Build Command
-inferred_lang: en-US
----
-
-# Quick Start Guide
-
-This document introduces how to quickly get started with the ZEN documentation generator.
-
-## Installation
-
-```bash
-npm install -g zengen
-```
-
-## Basic Usage
-
-1. Create a documentation directory
-2. Write Markdown files
-3. Run the build command
-
-```bash
-zengen build --src ./docs --out ./dist
-```
-
-## Features
-
-- Minimal configuration
-- Built-in responsive templates
-- AI-assisted metadata extraction
-- Multi-language support