Getting Started

This guide will help you quickly set up and start using LeafMove Smart Documentation Center.

📋 Prerequisites

Before you begin, ensure you have the following installed:

Required Software

  • Node.js (version 16.0 or higher)

    • Download from nodejs.org
    • Verify installation: node --version

  • npm (usually comes with Node.js)

    • Verify installation: npm --version
    • Alternative: yarn or pnpm

System Requirements

  • Operating System: Windows 10+, macOS 10.14+, or Linux
  • Memory: At least 4GB RAM
  • Storage: 500MB free space
  • Browser: Chrome, Firefox, Safari, or Edge (latest versions)

🚀 Installation

Step 1: Clone the Repository

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

# Navigate to the project directory
cd autodoc

Step 2: Install Dependencies

# Install all required packages
npm install

# This will install:
# - VuePress and related packages
# - Theme and plugins
# - Development dependencies

Step 3: Start Development Server

# Start the development server
npm run docs:dev

# You should see output similar to:
# ✔ Initializing and preparing data - done in 200ms
# 
#   vite v7.0.6 dev server running at:
# 
#   ➜  Local:   http://localhost:8080/
#   ➜  Network: http://192.168.1.100:8080/

Step 4: Access the Application

  1. Open your web browser
  2. Navigate to http://localhost:8080
  3. You should see the LeafMove Smart Documentation Center homepage

🎯 First Steps

Explore the Interface

  1. Navigation Bar: Located at the top with main sections
  2. Sidebar: Left panel showing document tree structure
  3. Content Area: Main area displaying document content
  4. Search: Use the search box or press s or /

Try the Search Function

  1. Click on the search box or press s
  2. Type "getting started"
  3. See real-time search results
  4. Click on a result to navigate
  1. Use the sidebar to browse different sections
  2. Click on expandable sections to see subsections
  3. Use breadcrumbs to understand your location
  4. Try the "Edit this page" link to see the source

📝 Creating Your First Document

Step 1: Create a New File

# Create a new markdown file
touch docs/my-first-document.md

Step 2: Add Content

# My First Document

This is my first document in LeafMove Smart Documentation Center.

## Introduction

Welcome to my documentation!

### Features

- Easy to write
- Automatically discovered
- Searchable content

## Code Example

```javascript
function hello() {
  console.log('Hello, LeafMove!');
}

Next Steps

  • Explore more features
  • Add more content
  • Customize the theme

### Step 3: See It in Action

1. Save the file
2. The development server will automatically reload
3. Your new document will appear in the navigation
4. Search for content from your new document

## 🔧 Basic Configuration

### Customize Site Information

Edit `docs/.vuepress/config.js`:

```javascript
export default defineUserConfig({
  locales: {
    '/': {
      title: 'Your Site Title',
      description: 'Your site description'
    }
  }
})

Add Navigation Items

navbar: [
  { text: 'Home', link: '/' },
  { text: 'Guide', link: '/guide/' },
  { text: 'Your Section', link: '/your-section/' },
]

🏗️ Building for Production

Build the Site

# Create production build
npm run docs:build

# Output will be in docs/.vuepress/dist/

Preview the Build

# Serve the built site locally
npx vuepress serve docs/.vuepress/dist

# Or use a simple HTTP server
npx serve docs/.vuepress/dist

🚨 Troubleshooting

Common Issues

Port Already in Use

# If port 8080 is busy, specify a different port
npm run docs:dev -- --port 3000

Node.js Version Issues

# Check your Node.js version
node --version

# If too old, update Node.js
# Visit https://nodejs.org/ for the latest version

Permission Errors

# On macOS/Linux, you might need to use sudo
sudo npm install

# Or fix npm permissions
npm config set prefix ~/.npm-global

Build Failures

# Clear cache and reinstall
rm -rf node_modules package-lock.json
npm install

Getting Help

If you encounter issues:

  1. Check the troubleshooting guide
  2. Search existing documentation
  3. Check the browser console for errors
  4. Visit our community forums
  5. Contact technical support

✅ Verification Checklist

Before proceeding, verify that:

  • [ ] Development server starts without errors
  • [ ] You can access the site at http://localhost:8080
  • [ ] Navigation works correctly
  • [ ] Search function is operational
  • [ ] You can create and view new documents
  • [ ] Hot reload works when editing files

🎉 What's Next?

Now that you have LeafMove Smart Documentation Center running:

  1. Learn Configuration - Customize your setup
  2. Content Creation - Master document creation
  3. Explore AutoBox - Try AI-assisted features
  4. API Documentation - Integrate with tools
  5. Deployment - Go live with your docs

📚 Additional Resources

Congratulations! You've successfully set up LeafMove Smart Documentation Center. Happy documenting! 🚀