跳到正文
TakoAPI
返回技能列表

neo-github-readme-generator

由 martinforsulu 提供

Git & GitHub
—暂无评分
你的评分

简介

Automatically generates comprehensive README files from GitHub repositories with installation, API docs, and usage.

描述

该技能的功能

Analyzes a GitHub repository and generates a README covering installation, usage, API documentation, and code examples. It reads package.json, requirements.txt, code comments, and function signatures to produce structured output. The result is a draft ready for review, not a final published document.

Extracting installation steps, API docs, and usage examples from code directly saves the manual work of cross-referencing multiple files to write them by hand.

何时使用

  • Documenting a new open-source project before its first release
  • Generating a README for a repo that has none
  • Refreshing outdated documentation by re-analyzing current code
  • Bootstrapping API docs from existing function signatures
  • Creating installation instructions for multi-language projects

示例工作流

输入

User asks: Generate a README for https://github.com/user/my-project

智能体
  1. 1

    Fetch repository structure and file tree via GitHub API

  2. 2

    Parse package.json and requirements.txt for dependencies and scripts

  3. 3

    Scan code comments and function signatures to extract API documentation

  4. 4

    Select matching README template based on project type and language

  5. 5

    Validate the generated README for required sections and completeness

输出

A markdown README file with installation steps, usage examples, and API reference sections populated from the repository contents

前置要求

  • GitHub personal access token (for private or rate-limited repos)

安装

clawhub install martinforsulu/neo-github-readme-generator

运行 CLI 命令,或把这段提示词粘贴到 Claude Code、Cursor、Codex 或你在用的任意编程智能体里。

链接