Publishing the Help Documentation

This folder contains the user-facing help documentation for OnixFeed. The docs are written in Markdown and published using VitePress - a static site generator with full SEO support and clean URLs.

How It Works

VitePress builds your Markdown files into static HTML pages with proper routes (e.g., /getting-started instead of /#/getting-started). This makes the content fully crawlable by search engines.

Key files:

• .vitepress/config.ts - Site configuration, navigation, sidebar
• .vitepress/theme/custom.css - OnixFeed branding and styles
• index.md - Home page with hero section
• *.md - Documentation pages
• public/images/ - Static assets (logo, screenshots)

Local Development

# Install dependencies
npm install

# Start dev server with hot reload
npm run dev

Then open http://localhost:5173

Building for Production

# Build static files
npm run build

# Preview the build locally
npm run preview

The build output goes to .vitepress/dist/.

Deploying to Production

Option 1: Hestia Server (Recommended)

1. Create subdomain help.onixfeed.com in Hestia
2. Build locally: npm run build
3. Upload .vitepress/dist/ contents to the public_html folder

# From your local machine
npm run build
rsync -avz .vitepress/dist/ user@server:/home/user/web/help.onixfeed.com/public_html/

Option 2: GitHub Pages

1. Push to GitHub
2. Add GitHub Actions workflow (see below)
3. Settings → Pages → Source: GitHub Actions
4. Custom domain: help.onixfeed.com

GitHub Actions workflow (.github/workflows/deploy.yml):

name: Deploy VitePress

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
      - run: npm ci
      - run: npm run build
      - uses: actions/upload-pages-artifact@v3
        with:
          path: .vitepress/dist
      - uses: actions/deploy-pages@v4

Option 3: Vercel/Netlify

1. Connect repo
2. Build command: npm run build
3. Output directory: .vitepress/dist
4. Custom domain in dashboard

Customization

Styling

Edit .vitepress/theme/custom.css:

:root {
  --vp-c-brand-1: #FAC525;    /* Primary color (yellow) */
  --vp-c-brand-2: #BB3E03;    /* Secondary color (orange) */
  --vp-sidebar-bg-color: #f5f0e5;  /* Sidebar background */
}

Dark mode is automatically handled with .dark class overrides.

Navigation

Edit .vitepress/config.ts:

• nav - Top navigation bar
• sidebar - Left sidebar menu structure

Adding Pages

1. Create a new .md file in the root
2. Add it to the sidebar array in config.ts
3. The dev server will hot reload

Adding Images

1. Place images in public/images/
2. Reference in Markdown: ![Description](/images/screenshot.png)
3. Images in public/ are served from the root URL

File Structure

docs/help-vite/
├── .vitepress/
│   ├── config.ts              # Site configuration
│   ├── theme/
│   │   ├── index.ts           # Theme entry
│   │   └── custom.css         # OnixFeed branding
│   ├── dist/                  # Build output (gitignored)
│   └── cache/                 # Build cache (gitignored)
├── public/
│   └── images/                # Static assets
│       └── onixfeed-help-logo.png
├── index.md                   # Home page
├── 01-getting-started.md
├── 02-managing-books.md
├── 03-contributors.md
├── 04-onix-feeds.md
├── 05-import-export.md
├── 06-stock-inventory.md
├── 07-reviews-content.md
├── 08-ecommerce-shopify.md
├── 09-account-settings.md
├── 10-troubleshooting.md
├── 11-onix-reference.md
├── 12-onixfeed-woo.md
├── package.json
└── PUBLISHING.md              # This file

Features Included

• Local Search - Full-text search across all pages
• Dark Mode - Toggle in the nav bar
• Syntax Highlighting - For code blocks
• Responsive - Mobile-friendly layout
• SEO - Static HTML with proper meta tags

Content Guidelines

When adding or editing documentation:

1. Use clear headings - H2 for main sections, H3 for subsections
2. Include screenshots - Place in public/images/
3. Link between docs - Use relative links [See Troubleshooting](/10-troubleshooting)
4. Keep it concise - Users want answers, not essays
5. Update config.ts - Add new pages to the sidebar

Related

• Support System Documentation - See docs/future-dev/UVDESK-SUPPORT-HUB.md for ticketing system (Zoho Desk)