API Reference

SmartDocs Config

smartdocs.config.js

Create a smartdocs.config.js in your project root:

/** @type {import('smartdocs').Config} */
module.exports = {
  title: 'My Docs',
  description: 'Documentation for my project',
  logo: '/logo.png',
  social: {
    github: 'https://github.com/username/project',
    twitter: 'https://twitter.com/username',
  },
  theme: {
    colors: {
      primary: '#3b82f6',
      secondary: '#8b5cf6',
    },
  },
};

CLI Commands

# Initialize a new docs site
npx smartdocs init my-docs

# Development server
npm run dev

# Build for production
npm run build

# Start production server
npm start

Deploy

Vercel (recommended)

Push to GitHub and import to Vercel. Add your environment variables in the Vercel dashboard. No configuration needed.

Static Export

npm run build
# Output in out/

Deploy the out/ folder to any static host (Netlify, GitHub Pages, S3).

Next: Quickstart