doc-smith

DocSmith Skills

English | 中文

Official Site · Showcase · Report Bug

Turn your codebase into a polished documentation site with a single slash command — analyze, generate, translate, and publish, all inside your AI coding agent.

See it in action — Browse real documentation sites generated by DocSmith: Showcase

Table of Contents

• How it Works
• Features
• Prerequisites
• Installation
• Quick Start
• Available Skills
  • doc-smith-create
  • doc-smith-localize
  • doc-smith-publish
• Workspace Structure
• FAQ
• Contributing
• License

How it Works

flowchart LR
    A[Analyze Project] --> B[Plan Structure]
    B --> C[Generate Docs]
    C --> D[Translate]
    D --> E[Publish]

    A -.- A1[Source code & project files]
    B -.- B1[User confirms outline]
    C -.- C1[HTML with AI images]
    D -.- D1[Multi-language support]
    E -.- E1[DocSmith Cloud URL]

Features

Prerequisites

• An AI coding agent that supports Skills — Claude Code, Cursor, Codex, Gemini CLI, or 35+ more
• Node.js >= 18

Installation

npx skills add AIGNE-io/doc-smith-skills

Powered by skills — the universal skill format for AI coding agents.

Or simply tell your AI coding agent:

Please install Skills from github.com/AIGNE-io/doc-smith-skills

# Register marketplace
/plugin marketplace add AIGNE-io/doc-smith-skills

# Install plugin
/plugin install doc-smith@doc-smith-skills

Use with OpenClaw

Publish your documentation via OpenClaw:

1. Visit DocSmith OpenClaw page
2. Sign in and click "Generate Publish Prompt"
3. Copy the prompt and paste it into OpenClaw

The prompt includes skill installation, credential setup, and publish instructions — OpenClaw handles the rest. The credential is saved automatically and persists across sessions.

Quick Start

Step 1 — Generate documentation:

/doc-smith-create Generate English documentation for the current project

DocSmith will analyze your project, then present a document outline for you to review and confirm. After your confirmation, it generates full HTML documentation with AI images in .aigne/doc-smith/dist/.

Step 2 — Translate to other languages (optional):

/doc-smith-localize Translate docs to Japanese and Chinese
/doc-smith-localize --lang ja --lang zh

Only changed documents are re-translated. Use --force to translate everything.

Step 3 — Publish online:

/doc-smith-publish

Uploads your docs to DocSmith Cloud and returns a shareable URL.

Available Skills