LeafMove Documentation Center

Welcome to LeafMove Documentation Center - an intelligent document management system based on VuePress, supporting automatic discovery, full-text search, and API documentation.

🌟 Key Features

1. Automatic Document Discovery

  • Smart Scanning: Automatically scans the docs/ directory and generates navigation
  • Real-time Updates: New documents are automatically added to the navigation
  • Hierarchical Structure: Supports multi-level directory organization
  • README Priority: README.md files are displayed first, other files are sorted alphabetically

2. Powerful Search

  • Full-text Search: Search across all document content
  • Real-time Suggestions: Intelligent search suggestions as you type
  • Keyboard Shortcuts: Quick search with s or / keys
  • Result Highlighting: Search results are highlighted for easy identification

3. Smart Content Management

Efficient document content management:

  • 📝 Markdown Support - Complete Markdown syntax support
  • 🎨 Theme Customization - Flexible theme configuration and style customization
  • 🔗 Link Management - Smart link checking and management
  • 📊 Content Analytics - Document content statistics and analysis

4. Automated Deployment

Complete automated deployment process:

  • ✅ Document format checking
  • 🔗 Link validity verification
  • 🏗️ Automatic document building
  • 🚀 GitHub Pages deployment
  • 📢 Deployment status notifications

📁 Project Structure

AutoDoc/
├── 📁 docs/                    # Document source files
│   ├── 📁 .vuepress/          # VuePress configuration
│   │   ├── 🔧 config.js       # Main configuration file
│   │   └── 📂 public/         # Static resources
│   ├── 📖 guide/              # User guide
│   ├── 📋 api/                # API documentation
│   └── 🧠 ai/                 # AI assistant related
├── 📁 .github/                # GitHub Actions
│   └── 📁 workflows/          # CI/CD workflows
└── 📦 package.json            # Project configuration

🚀 Quick Start

Prerequisites

  • Node.js 16.0 or higher
  • npm or yarn package manager

Installation

# Clone the repository
git clone https://github.com/your-username/autodoc.git
cd autodoc

# Install dependencies
npm install

# Start development server
npm run docs:dev

# Visit http://localhost:8080

Basic Usage

  1. Add Documents: Create .md files in the docs/ directory
  2. Automatic Discovery: New files are automatically added to navigation
  3. Preview Changes: Development server automatically reloads
  4. Build for Production: Run npm run docs:build

📖 Documentation Sections

📖 User Guide

Complete usage documentation covering installation, configuration, and best practices.

🤖 AutoBox

AI-assisted programming features including prompt libraries, usage guides, and case studies.

📋 API Docs

Comprehensive API documentation with authentication guides, examples, and error code references.

🎯 Getting Started

We recommend reading the documentation in the following order:

  1. Quick Start - Learn basic installation and configuration
  2. Configuration - Detailed configuration options
  3. Content Creation - Learn how to create document content
  4. Deployment Guide - Deploy to production environment
  5. AutoBox - Use AI-assisted programming features

Advanced Features

  1. Configuration Guide - Detailed configuration options
  2. Deployment Guide - Production environment deployment
  3. Content Creation - Document writing guide
  4. AutoBox Usage - AI-assisted programming guide

🤝 Contributing

We welcome contributions of all kinds! See the Contributing Guide for details.

📄 License

This project is licensed under the ISC License.

LeafMove Documentation Center - Making documentation intelligent and efficient! 🚀