Getting Started

Welcome to SmartDocs! This is a sample documentation site to get you started.

Quick Start

Install the CLI:

npx smartdocs init my-docs
cd my-docs

Set up your API key in .env:

SMARTDOCS_AI_PROVIDER=openai
SMARTDOCS_API_KEY=sk-...
SMARTDOCS_MODEL=gpt-4o-mini

Run the dev server:

npm run dev

Visit http://localhost:3000 — your docs are live with AI chat.

Writing Docs

Add Markdown files to the content/ folder. The folder structure becomes your URL structure:

content/
├── index.md           → /
├── getting-started/
│   └── quickstart.md  → /getting-started/quickstart
├── guides/
│   └── configuration.md → /guides/configuration
└── api/
    └── reference.md   → /api/reference

Adding AI Chat

Once your API key is configured in .env, every page automatically gets an AI chat bubble. Readers can ask questions about your docs and get grounded answers.

Next: Configuration Guide