Skip to content

README.md

Latest commit

 

History

History
259 lines (191 loc) · 5 KB

README.md

File metadata and controls

259 lines (191 loc) · 5 KB

Honeymelon Documentation

This directory contains the complete documentation for Honeymelon, built with VitePress.

Structure

docs/
├── .vitepress/              # VitePress configuration
│   ├── config.ts           # Site configuration
│   ├── env.d.ts            # Type declarations
│   └── theme/              # Custom theme
├── public/                  # Static assets
│   ├── favicon.ico
│   ├── favicon.svg
│   ├── favicon-16x16.png
│   ├── favicon-32x32.png
│   └── logo.svg
├── index.md                 # Homepage
├── changelog.md             # Version history
├── ROADMAP.md               # Product roadmap
├── FFMPEG_PIPELINE_TESTS.md # FFmpeg pipeline test notes
│
├── adr/                     # Architecture Decision Records
│   └── README.md
│
├── guide/                   # User guides
│   ├── what-is-honeymelon.md
│   ├── getting-started.md
│   ├── converting-files.md
│   ├── presets.md
│   ├── batch-processing.md
│   ├── preferences.md
│   ├── privacy.md
│   ├── support.md
│   ├── supported-formats.md
│   └── troubleshooting.md
│
├── architecture/            # Technical architecture
│   ├── overview.md
│   ├── pipeline.md
│   ├── pipeline-internals.md
│   ├── ffmpeg.md
│   ├── adr.md
│   ├── state.md
│   └── tech-stack.md
│
├── development/             # Development guides
│   ├── contributing.md
│   ├── build.md
│   ├── building.md
│   ├── testing.md
│   ├── agents.md
│   ├── claude.md
│   ├── api-reference.md
│   ├── deployment.md
│   ├── enhancement-plan.md
│   └── roadmap.md
│
└── legal/                   # Legal documentation
    ├── license-compliance.md
    └── third-party-notices.md

Development

Prerequisites

  • Node.js 18+
  • npm or pnpm

Commands

# Start development server
npm run docs:dev

# Build for production
npm run docs:build

# Preview production build
npm run docs:preview

Development Server

The docs will be available at http://localhost:5173/

Features

  • Comprehensive user guides
  • Detailed architecture documentation
  • Development and contribution guides
  • Legal and compliance information
  • Full-text search (built-in)
  • Responsive design
  • Dark mode support
  • Markdown support with extensions
  • Mermaid diagrams
  • Code syntax highlighting

Writing Documentation

Markdown Features

VitePress supports GitHub-flavored Markdown plus additional features:

Custom Containers

::: tip
Helpful tip for users
:::

::: warning
Important warning
:::

::: danger
Critical information
:::

::: info
General information
:::

Code Groups

::: code-group

````bash [npm]
npm install
\```

```bash [pnpm]
pnpm install
\```

:::

````

#### Mermaid Diagrams

````markdown

```mermaid
graph LR
    A[Start] --> B[End]
```

Adding a New Page

  1. Create a new .md file in the appropriate directory

  2. Add frontmatter (optional):

    ---
title: Page Title
description: Page description
---

  3. Write content in Markdown

  4. Update sidebar configuration in .vitepress/config.ts

Linking Between Pages

Use relative paths:

[Getting Started](./getting-started.md)
[Architecture](/architecture/overview.md)

Deployment

Build

npm run docs:build

Output will be in docs/.vitepress/dist/

Hosting Options

  • GitHub Pages: Deploy from dist/ directory
  • Netlify: Auto-deploy from repo
  • Vercel: Auto-deploy from repo
  • Cloudflare Pages: Auto-deploy from repo

Custom Domain

Configure in .vitepress/config.ts:

export default {
  base: '/', // For root domain
  // or
  base: '/honeymelon/', // For subdirectory
};

Configuration

Main configuration file: .vitepress/config.ts

Key settings:

  • title: Site title
  • description: Site description
  • themeConfig: Theme configuration
    • nav: Top navigation
    • sidebar: Sidebar navigation
    • socialLinks: Social media links
    • search: Search configuration
    • footer: Footer content

Maintenance

Keeping Documentation Updated

  • Update changelog when releasing new versions
  • Add new features to relevant guide pages
  • Keep architecture docs in sync with code
  • Update troubleshooting guide with common issues

Checking Links

# Check for broken links
npx vitepress check-links docs

Spell Checking

Use a markdown spell checker extension in your editor.

Contributing

See Contributing Guide for information on how to contribute to the documentation.

Questions?

For questions about the documentation: