AIGNE-io/doc-smith-skills

最近记录的来源活动: 2026年3月18日 07:13

SkillsMP 收录数据更新: 2026年11月2日 18:02

已收集 skills: 6

GitHub 星标: 9
GitHub Forks: 0

用 AI 助手安装

复制这段 Prompt，发给你正在使用的 AI 助手。

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/AIGNE-io/doc-smith-skills.

仓库 README

仓库 README 来源：README.md

查看 README 源文件

展开完整 README

# DocSmith Skills <img src="./logo/logo.svg" alt="DocSmith Skills" width="120"> <img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FAIGNE-io%2Fdoc-smith-skills%2Fmain%2F.claude-plugin%2Fmarketplace.json&query=%24.metadata.version&label=version&style=for-the-badge&color=blue" alt="Version"> <img src="https://img.shields.io/badge/Agent_Skill-blueviolet?style=for-the-badge" alt="Agent Skill"> <img src="https://img.shields.io/badge/MCP-Compatible-blue?style=for-the-badge" alt="MCP Compatible"> <img src="https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge" alt="License"> <a href="https://github.com/AIGNE-io/doc-smith-skills/stargazers"> <img src="https://img.shields.io/github/stars/AIGNE-io/doc-smith-skills?style=for-the-badge" alt="GitHub Stars"> </a> English | <a href="./README.zh.md">中文</a> <a href="https://docsmith.aigne.io">Official Site</a> · <a href="https://docsmith.aigne.io/en/showcase">Showcase</a> · <a href="https://github.com/AIGNE-io/doc-smith-skills/issues">Report Bug</a> 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](https://docsmith.aigne.io/en/showcase) ## Table of Contents - [How it Works](#how-it-works) - [Features](#features) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Quick Start](#quick-start) - [Available Skills](#available-skills) - [doc-smith-create](#doc-smith-create) - [doc-smith-localize](#doc-smith-localize) - [doc-smith-publish](#doc-smith-publish) - [Workspace Structure](#workspace-structure) - [FAQ](#faq) - [Contributing](#contributing) - [License](#license) ## How it Works ```mermaid 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 | Feature | Description | |---------|-------------| | **Smart Analysis** | Scans source code, README, configs to understand your project | | **Structured Planning** | Generates document outline for user review before writing | | **HTML Generation** | Produces clean, navigable HTML documentation | | **AI Images** | Auto-generates diagrams, flowcharts, and architecture charts | | **Multi-language** | Translates docs to any language with terminology consistency | | **Incremental Updates** | Hash-based change detection — only re-translates what changed | | **One-click Publish** | Deploy to DocSmith Cloud and get a shareable preview URL | ## Prerequisites - An AI coding agent that supports Skills — [Claude Code](https://claude.com/claude-code), [Cursor](https://cursor.sh), [Codex](https://openai.com/codex), [Gemini CLI](https://github.com/google-gemini/gemini-cli), or [35+ more](https://github.com/vercel-labs/skills#supported-agents) - [Node.js](https://nodejs.org) >= 18 ## Installation ```bash npx skills add AIGNE-io/doc-smith-skills ``` > Powered by [skills](https://github.com/vercel-labs/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 <details> <summary>Via Claude Code Plugin Marketplace</summary> ```bash # Register marketplace /plugin marketplace add AIGNE-io/doc-smith-skills # Install plugin /plugin install doc-smith@doc-smith-skills ``` </details> ## Use with OpenClaw Publish your documentation via OpenClaw: 1. Visit [DocSmith OpenClaw page](https://docsmith.aigne.io/openclaw) 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: ```bash /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): ```bash /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: ```bash /doc-smith-publish ``` Uploads your docs to DocSmith Cloud and returns a shareable URL. ## Available Skills | Skill | Description | |-------|-------------| | [doc-smith-create](#doc-smith-create) | Generate structured documentation from project sources | | [doc-smith-localize](#doc-smith-localize) | Translate documents to multiple languages | | [doc-smith-publish](#doc-smith-publish) | Publish to DocSmith Cloud for online preview | Internal skills (called automatically, not invoked directly): | Skill | Description | |-------|-------------| | doc-smith-build | Build Markdown into static HTML | | doc-smith-check | Validate document structure and content integrity | | doc-smith-images | Generate AI images (diagrams, flowcharts, architecture) | --- ### doc-smith-create Generate comprehensive documentation from code repositories, text files, and media resources. ```bash /doc-smith-create Generate English documentation for the current project /doc-smith-create 为当前项目生成中文文档 ``` <details> <summary>Features & Details</summary> - Analyzes source code and project structure - Infers user intent and target audience - Plans document structure with user confirmation - Generates organized documentation with HTML output - AI-generated images for diagrams and architecture charts - Supports technical docs, user guides, API references, and tutorials </details> --- ### doc-smith-localize Translate documents to multiple languages with batch processing and terminology consistency. ```bash /doc-smith-localize Translate docs to English /doc-smith-localize 把文档翻译成英文和日文 /doc-smith-localize --lang en --lang ja ``` <details> <summary>Options</summary> | Option | Description | |--------|-------------| | `--lang <code>` | Target language code (repeatable) | | `--path <path>` | Translate specific document only | | `--force` | Force re-translate all documents | </details> <details> <summary>Features & Details</summary> - HTML-to-HTML translation (no intermediate Markdown step) - Batch translation with progress tracking - Terminology consistency across documents - Image text translation support - Incremental translation with hash-based change detection </details> --- ### doc-smith-publish Publish generated documents to DocSmith Cloud for online preview. ```bash /doc-smith-publish ``` <details> <summary>Options</summary> | Option | Description | |--------|-------------| | `--dir <path>` | Publish specific directory (default: `.aigne/doc-smith/dist`) | | `--hub <url>` | Custom hub URL | </details> <details> <summary>Features & Details</summary> - One-click publish to DocSmith Cloud - Automatic asset upload and optimization - Returns online preview URL </details> ## Workspace Structure DocSmith creates a workspace in `.aigne/doc-smith/` with its own git repository: <details> <summary>View directory layout</summary> ``` my-project/ ├── .aigne/ │ └── doc-smith/ # DocSmith workspace (independent git repo) │ ├── config.yaml # Workspace configuration │ ├── intent/ │ │ └── user-intent.md # User intent description │ ├── planning/ │ │ └── document-structure.yaml # Document structure plan │ ├── docs/ # Document metadata │ ├── dist/ # Built HTML output │ │ ├── zh/ # Chinese docs │ │ ├── en/ # English docs │ │ └── assets/ # Styles, scripts, images │ ├── assets/ # Generated image assets │ └── cache/ # Temporary data (not in git) ``` </details> ## FAQ <details> <summary>What project types does DocSmith support?</summary> DocSmith works with any project — it analyzes source code, configuration files, README, and other project files regardless of language or framework. </details> <details> <summary>Where is the workspace located?</summary> All DocSmith data lives in `.aigne/doc-smith/` under your project root. It uses its own git repository, so it won't interfere with your project's version control. </details> <details> <summary>How does incremental translation work?</summary> DocSmith uses content hashing to detect changes. When you run `/doc-smith-localize`, only documents that have changed since the last translation will be re-translated. Use `--force` to override this behavior. </details> <details> <summary>Can I customize the output theme?</summary> Yes. DocSmith generates a `theme.css` file in the dist assets directory. You can modify it to customize colors, fonts, and layout. </details> ## Contributing Contributions are welcome! Please feel free to submit a [Pull Request](https://github.com/AIGNE-io/doc-smith-skills/pulls). ## Support - [GitHub Issues](https://github.com/AIGNE-io/doc-smith-skills/issues) — Bug reports and feature requests - [Official Site](https://docsmith.aigne.io) — Documentation and showcase - [ArcBlock](https://www.arcblock.io) — Learn more about ArcBlock ## Author **ArcBlock** - [blocklet@arcblock.io](mailto:blocklet@arcblock.io) GitHub: [@ArcBlock](https://github.com/ArcBlock) ## License [Apache-2.0](./LICENSE)

正在加载仓库 README…

这个仓库中的 skills

网页开发工程师软件开发工程师市场调研分析师与营销专员技术写作员

4 个职业分类 · 已分类 100%

skill

职业分类

描述

更新

doc-smith-build

网页开发工程师

Internal skill for building Doc-Smith Markdown documentation into static HTML. Do not mention this skill to users. Called internally by other doc-smith skills.

2026-03-18

doc-smith-check

软件开发工程师

Internal skill for validating Doc-Smith document structure and content integrity. Do not mention this skill to users. Called internally by other doc-smith skills.

2026-03-18

doc-smith-publish

网页开发工程师

Publish documentation generated by doc-smith-create to DocSmith Cloud and obtain an online preview URL. Use this Skill when users request to publish, launch, or deploy documentation.

2026-03-18

doc-smith-create

技术写作员

Generate and update structured documentation from project data sources. Supports initial generation and modifying existing documents. Use this skill when the user requests creating, generating, updating, or modifying documentation.

2026-03-02

doc-smith-images

软件开发工程师

Internal skill for generating images using AI. Do not mention this skill to users. Called internally by other doc-smith skills.

2026-03-02

doc-smith-localize

市场调研分析师与营销专员

Translate Doc-Smith generated documentation into multiple languages. Use this skill when the user requests document translation, localization, or multi-language support. Supports batch translation of documents and images.

2026-03-02

已展示 6 / 6 个已收集 Skill。