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.

9 starsWriting & Content Plugin marketplace

Install

Claude Code plugin
/plugin marketplace add AIGNE-io/doc-smith-skills

The repo is a Claude Code plugin marketplace. Run /plugin afterwards to pick the plugin that includes this skill.

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add AIGNE-io/doc-smith-skills --skill doc-smith-build
Manual install
git clone --depth 1 https://github.com/AIGNE-io/doc-smith-skills.git /tmp/doc-smith-skills
mkdir -p ~/.claude/skills
cp -r /tmp/doc-smith-skills/skills/doc-smith-build ~/.claude/skills/doc-smith-build

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# Doc-Smith HTML 构建

双模式构建:`--nav` 生成导航和静态资源,`--doc` 构建单篇文档。

## 用法

```bash
# 生成 nav.js + 复制资源 + 创建重定向
node skills/doc-smith-build/scripts/build.mjs \
  --nav --workspace .aigne/doc-smith --output .aigne/doc-smith/dist

# 构建单篇文档
node skills/doc-smith-build/scripts/build.mjs \
  --doc .aigne/doc-smith/docs/overview/zh.md --path /overview \
  --workspace .aigne/doc-smith --output .aigne/doc-smith/dist
```

## 选项

| Option | Alias | Description |
|--------|-------|-------------|
| `--nav` | | 生成 nav.js、复制 CSS、创建重定向页面 |
| `--doc <file>` | | 构建单篇 MD 文件为 HTML |
| `--path <path>` | | 文档路径(如 `/overview`),`--doc` 模式必需 |
| `--workspace <path>` | `-w` | Doc-Smith workspace(默认 `.aigne/doc-smith`) |
| `--output <path>` | `-o` | 输出目录(默认 `<workspace>/dist`) |

## 模式说明

### --nav 模式

从 `document-structure.yaml` + `config.yaml` 生成导航数据和静态资源。

**输出:**
- `assets/nav.js` — 导航数据(`window.__DS_NAV__ = {...}`),侧边栏和语言切换由此驱动
- `assets/docsmith.css` — 内置基础样式
- `assets/theme.css` — 用户主题(不存在时创建空文件)
- `index.html` — 根重定向
- `{lang}/index.html` — 语言重定向

**调用时机:** 初始化时、文档结构变更后。

### --doc 模式

构建单篇 MD 文件为完整 HTML 页面。

**输入:** MD 文件路径 + 文档 path
**输出:** `dist/{lang}/docs/{path}.html`

**职责:**
- Markdown → HTML 转换(markdown-it)
- 套 HTML 骨架(data-ds 锚点)
- 生成 TOC(页面内联)
- 处理图片占位符(``)
- `/assets/` 路径转换为相对路径(见下方路径契约)
- 拼接静态资源引用(CSS + nav.js)

**不负责:** 导航渲染(nav.js 客户端完成)、MD 清理(调用方负责)。

### 路径契约

MD 文件中使用 `/assets/` 绝对路径引用资源,build.mjs 自动转换为相对路径:

| MD 中写法 | HTML 输出(depth=1) | HTML 输出(depth=2) |
Read the full skill on GitHub

Details

Skill name
doc-smith-build
Path
skills/doc-smith-build/SKILL.md
License
Apache-2.0
Repo updated
18 March 2026

FAQ

What does the Doc Smith Build skill do?

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.

How do I install the Doc Smith Build skill?

Claude Code plugin: /plugin marketplace add AIGNE-io/doc-smith-skills. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Doc Smith Build popular?

It lives in AIGNE-io/doc-smith-skills, which has 9 GitHub stars and 0 forks.

Related skills

Doc Smith Check

9

AIGNE-io/doc-smith-skills

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.

Writing & Content

Doc Smith Create

9

AIGNE-io/doc-smith-skills

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.

Skill & Plugin Authoring

Doc Smith Images

9

AIGNE-io/doc-smith-skills

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

Images, Video & Audio

Writing Strategy

9

comfuture/agent-skills

Choose writing and narrative strategies from a curated bilingual strategy set, then produce a Markdown article outline or table of contents. Use when the user asks how to structure a draft, essay, article, post, proposal, column, case study, story, marketing copy, or other writing based on a topic, material, purpose, audience/readers, tone, or language. The skill selects a best-fit strategy, avoids overusing generic problem-solution frames, keeps Korean and English strategy names as canonical references, and displays strategy names in the user's output language unless bilingual names are expli

Writing & Content

Doc Smith Localize

9

AIGNE-io/doc-smith-skills

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.

Writing & Content

User Story Mapping

5

tomershahar/user-story-mapping-skill

Use when a user wants to create, facilitate, or generate a user story map for a product or feature — either guided step-by-step (coaching mode) or from a raw requirement (generation mode).

Writing & Content

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.