create-vexdocs-app

Create a new Vexdocs documentation project with the latest version from npm.

Quick Start

# Create a new project
npx create-vexdocs-app my-docs

# Or just run and it will prompt for folder name
npx create-vexdocs-app

What it does

1. Downloads the latest vexdocs from npm
2. Extracts all files (src/, assets/, vexdocs executable, docs/)
3. Creates a complete project with everything included
4. Sets up ready-to-use documentation with examples and guides

Project Structure

The command creates a complete vexdocs project:

my-docs/
├── src/                  # Vexdocs source files
├── assets/               # Theme assets
├── vexdocs               # Executable
├── docs/
│   ├── config.json      # Configuration
│   └── v1.0/            # Default version
│       ├── README.md    # Example documentation
│       ├── guides/      # Documentation guides
│       └── ...          # Complete documentation examples
├── package.json          # Project configuration
└── README.md            # Project info

Features

• ✅ Latest version - Always downloads the newest vexdocs
• ✅ Complete setup - All files included, no dependencies needed
• ✅ Full documentation - Includes all guides and examples
• ✅ Zero configuration - Works out of the box
• ✅ Offline ready - No internet needed after creation
• ✅ Executable included - Local vexdocs command available

Usage

Basic Usage

npx create-vexdocs-app my-docs

This will prompt you for the project name if not provided.

After Creation

cd my-docs
npm start          # Start development server
npm run build      # Build for production

Commands Available

Once created, you can use:

# Development
npm start          # Start server
npm run dev        # Development mode

# Production
npm run build      # Build static site
npm run serve      # Serve built files

# Direct vexdocs commands
./vexdocs serve    # Start server
./vexdocs build    # Build site
./vexdocs dev      # Development mode

Configuration

The generated docs/config.json includes:

{
  "title": "My Documentation",
  "description": "Project documentation",
  "versions": {
    "v1.0": "Latest"
  },
  "defaultVersion": "v1.0",
  "theme": {
    "primaryColor": "#007acc",
    "sidebarWidth": "300px"
  },
  "sidebarOrder": {
    "v1.0": [
      "getting-started.md",
      {
        "folder": "guides",
        "items": [
          "deployment.md",
          "markdown-guide.md",
          "troubleshooting.md"
        ]
      },
      "api-reference.md",
      "configuration.md",
      "setup.md"
    ]
  }
}

Customization

Adding Content

1. Edit files in docs/v1.0/ directory
2. Add new .md files for more pages
3. Create new version directories for multiple versions

Styling

Edit docs/config.json to customize:

• Site title and description
• Theme colors
• Sidebar width
• Version labels
• Sidebar order

Examples

Create a React Documentation

npx create-vexdocs-app react-docs
cd react-docs
npm start

Create an API Documentation

npx create-vexdocs-app api-docs
cd api-docs
npm start

Learn More

• Vexdocs Documentation
• Markdown Guide
• Deployment Guide

License

MIT License - see the LICENSE file for details.