全部技能 分类浏览
← 返回
开发者工具 中文

Docs Generator

Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL.
自动化文档生成器。API 文档、README、CHANGELOG、贡献指南、架构文档、教程、FAQ、参考手册。REST、GraphQL。
ckchzh ckchzh 来源
开发者工具 clawhub v2.0.0 4 版本 99881.7 Key: 无需
★ 1
Stars
📥 824
下载
💾 12
安装
4
版本
#chinese#latest#productivity

概述

Docs Generator — Automated Documentation

Spend less time writing docs, more time writing code.

Command Map

┌─ api ──────── REST/GraphQL API documentation
├─ readme ───── Project README.md
├─ changelog ── Version change log
├─ contributing Contributing guide
├─ architecture System architecture docs
├─ tutorial ─── Tutorial / quick start guide
├─ faq ──────── Frequently asked questions
└─ reference ── Complete reference manual

Usage

bash scripts/docs-generator.sh api rest users
bash scripts/docs-generator.sh readme myproject "A cool tool"
bash scripts/docs-generator.sh changelog 2.0.0 "New features"

Arguments

  • api — type: rest/graphql, resource name
  • readme — project name and description
  • changelog — version and summary
  • contributing — project name
  • architecture