@tidyfactor/doc
v1.9.0
Published
TidyFactor Doc — Code Documentation Builder, ADR Architect, Link Auditor & Triple-Engine Publishing Platform (VitePress, MkDocs Material & Docsify) for AI Coding Agents
Maintainers
Readme
tidyfactor-doc v1.6.0
面向 AI 智能体的代码库文档自动生成与双引擎发布平台 (MkDocs & Docsify)
English • العربية • فارسی • Español • Português • 简体中文 • Deutsch • Français
⚡ 快速上手 (Quickstart)
# 通过 NPX 快速运行
npx @tidyfactor/cli-doc或在 AI 编码助手 (Google Antigravity, Claude Code, Cursor, Codex) 中调用:
/tidyfactor-doc📋 核心命令矩阵
| 命令 | 目标与产出 | 执行工作流 |
|---|---|---|
| /init | Inicialización de estructura de documentación | workflows/init.md |
| /collect | Entrevista y análisis de código fuente | workflows/collect.md |
| /generate | Generación de especificaciones API y READMEs | workflows/generate.md |
| /mkdocs | Compilación de portal estático MkDocs Material | workflows/mkdocs.md |
| /docsify | Despliegue de SPA ligera Docsify sin compilación | workflows/docsify.md |
📖 完整技术规范与文档
如需查看深层架构设计、完整 JSON Schema 契约和原生代码,请参阅英文权威技术文档 (README.md)。
