Create API Docs 🚀

npx create-api-docs

Command that automatically sets up modern Docusaurus (with Lunr Search) docs autogenerated from OpenAPI spec & Typedoc function comments

✨ Features

• Interactive Setup: Guided configuration wizard with intelligent defaults
• TypeScript Support: Automatic TypeDoc integration for function documentation
• OpenAPI/Swagger: Built-in support for OpenAPI specification documentation
• GitHub Integration: Automatic source linking and see-on-GitHub functionality
• Modern UI: Beautiful, responsive documentation site with search

🛠️ Configuration Options

The setup wizard guides you through configuring:

| Option | Description | Default | |--------|-------------|---------| | Name | Documentation title and browser tab | Project name | | Domain | Base URL for hosting docs | https://api.example.com | | TypeDoc ID | Folder name for function docs | functions | | Entry Points | Glob pattern for TypeScript files | ../src/**/* | | Git Repo Path | GitHub URL for source links | Auto-detected | | Source Link Template | GitHub links with {path} and {line} | Auto-generated | | OpenAPI Spec | Path to OpenAPI/Swagger file | Optional | | Analytics ID | Google Analytics tracking ID | Optional | | Logo & Branding | Custom logos and favicons | Default icons |

📁 Generated Structure

After running the setup, you'll get:

your-project/
├── docs-config/
│   ├── config/
│   │   └── customize-docs.js    # Your configuration
│   ├── docusaurus.config.ts     # Docusaurus config
│   ├── package.json             # Dependencies
│   └── src/                     # Documentation source
├── docs/                        # Generated documentation
└── package.json                 # Your project config

🎨 Customization

Branding

• Custom logos and favicons
• Brand colors and styling
• Custom domain configuration

Documentation

• TypeDoc function documentation
• OpenAPI/Swagger integration
• README as homepage option
• Custom navigation and sidebar

Features

• GitHub source linking
• Edit-on-GitHub functionality
• Google Analytics integration
• Search functionality
• Mobile-responsive design

🌟 Star this repo so it will grow and get updates!