Focusly Documentation

This directory contains the documentation for Focusly, built with VitePress.

Development

# Install dependencies
npm install

# Start dev server (http://localhost:5173)
npm run docs:dev

# Build for production
npm run docs:build

# Preview production build
npm run docs:preview

Deployment

The documentation is automatically deployed to Vercel when changes are pushed to the main branch.

Setting up Vercel

1. Go to Vercel Dashboard
2. Click "Add New..." → "Project"
3. Import the focusly repository
4. Configure the project:
   • Framework Preset: Other
   • Root Directory: docs
   • Build Command: npm run docs:build
   • Output Directory: .vitepress/dist
5. Add a custom domain (e.g., docs.focusly.one or help.focusly.one)
6. Deploy!

Structure

docs/
├── .vitepress/
│   ├── config.ts       # VitePress configuration
│   └── dist/           # Build output (gitignored)
├── getting-started/    # Getting started guides
├── features/          # Feature documentation
├── guides/            # How-to guides
├── account/           # Account management docs
├── index.md           # Homepage
└── ...

Configuration

Edit .vitepress/config.ts to:

• Update site title, description, and logo
• Modify navigation and sidebar
• Customize theme colors
• Add or remove features

Writing Content

All documentation is written in Markdown. VitePress supports:

• Standard Markdown
• GitHub Flavored Markdown
• Custom containers (tip, warning, danger, etc.)
• Code highlighting
• Custom components

See the VitePress documentation for more details.