github-readme-generator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

GitHub README Generator

专业的 GitHub 项目 README.md 生成器，自动生成符合开源社区规范的文档结构。

A professional GitHub project README.md generator that automatically generates documentation structures compliant with open-source community standards.

功能概述

Feature Overview

这个 Skill 可以帮助你：

📝 自动生成标准的 GitHub README.md 文档
🎯 根据项目类型自动调整文档结构
📊 生成项目统计和路线图
🔗 自动生成 Star History 和 Badge
📧 包含作者联系和打赏信息
❓ 生成常见问题 FAQ
📚 支持中英文双语

This Skill can help you:

📝 Automatically generate standard GitHub README.md documents
🎯 Automatically adjust document structure based on project type
📊 Generate project statistics and roadmap
🔗 Automatically generate Star History and Badges
📧 Include author contact and donation information
❓ Generate frequently asked questions (FAQ)
📚 Support both Chinese and English languages

核心特性

Core Features

标准文档结构

Standard Document Structure

markdown

undefined

markdown

undefined

项目标题

Project Title

项目简介/副标题

Project Introduction/Subtitle

项目介绍

Project Introduction

项目概述
核心功能
技术栈

Project Overview
Core Features
Tech Stack

功能清单

Feature List

功能名称	说明	状态

Feature Name	Description	Status

安装说明

Installation Instructions

环境要求

Environment Requirements

安装步骤

Installation Steps

使用说明

Usage Instructions

快速开始

Quick Start

配置说明

Configuration Instructions

使用示例

Usage Examples

项目结构

Project Structure

undefined

undefined

技术栈

Tech Stack

| 技术 | 版本 | 用途 |

| Technology | Version | Purpose |

文档地址

Documentation Links

飞书文档
在线文档

Feishu Docs
Online Documentation

开发指南

Development Guide

本地开发

Local Development

构建部署

Build and Deployment

贡献指南

Contribution Guide

常见问题

FAQ

<details> <summary>Question</summary> Answer </details>

技术交流群

Technical Communication Group

欢迎加入技术交流群，分享你的 Skills 和使用心得：

Screenshot_20260210_085255_com.tencent.mm

Welcome to join the technical communication group to share your Skills and usage experience:

作者联系

Author Contact

微信: laohaibao2025
邮箱: 75271002@qq.com

WeChat: laohaibao2025
Email: 75271002@qq.com

打赏

Donation

如果这个项目对你有帮助，欢迎请我喝杯咖啡 ☕

微信支付

If this project helps you, feel free to buy me a coffee ☕

WeChat Pay

项目统计

Project Statistics

代码统计

Code Statistics

版本历史

Version History

路线图

Roadmap

计划功能

Planned Features

优化项

Optimization Items

License

SPDX-License-Identifier: MIT

Star History

[Star History 图片]

undefined

[Star History Image]

undefined

使用方法

Usage Methods

方式一：交互式生成

Method 1: Interactive Generation

直接提出需求，系统会引导你提供必要信息：

请帮我的项目生成一个 README.md

需要提供的信息：
1. 项目名称
2. 项目简介
3. 技术栈
4. 核心功能
5. 安装步骤
6. 使用示例
7. 作者信息
8. 是否需要打赏信息

Directly submit your request, and the system will guide you to provide necessary information:

Please generate a README.md for my project

Required information:
1. Project Name
2. Project Introduction
3. Tech Stack
4. Core Features
5. Installation Steps
6. Usage Examples
7. Author Information
8. Whether donation information is needed

方式二：基于现有项目自动生成

Method 2: Automatic Generation Based on Existing Projects

请基于当前项目自动生成 README.md

系统会自动分析：

项目结构（目录、文件）
技术栈（package.json, go.mod, pom.xml 等）
构建脚本（Makefile, build.sh）
配置文件
现有文档

Please automatically generate a README.md based on the current project

The system will automatically analyze:

Project structure (directories, files)
Tech stack (package.json, go.mod, pom.xml, etc.)
Build scripts (Makefile, build.sh)
Configuration files
Existing documentation

方式三：使用模板快速生成

Method 3: Quick Generation Using Templates

请使用 [模板名称] 生成 README

可用模板：

```
basic
```
- 基础模板
```
full
```
- 完整模板（包含所有章节）
```
minimal
```
- 极简模板
```
library
```
- 库/SDK 专用模板
```
webapp
```
- Web 应用模板
```
cli
```
- CLI 工具模板
```
api
```
- API 服务模板

Please generate a README using [Template Name]

Available templates:

```
basic
```
- Basic template
```
full
```
- Complete template (includes all sections)
```
minimal
```
- Minimalist template
```
library
```
- Template for libraries/SDKs
```
webapp
```
- Web application template
```
cli
```
- CLI tool template
```
api
```
- API service template

文档结构说明

Document Structure Explanation

必选章节

Mandatory Sections

章节	说明	优先级
项目标题	清晰的项目名称和副标题	P0
项目简介	一句话描述项目核心价值	P0
功能清单	表格形式列出主要功能	P0
安装说明	环境要求和安装步骤	P0
使用说明	快速开始和基本用法	P0
License	开源协议声明	P0

Section	Description	Priority
Project Title	Clear project name and subtitle	P0
Project Introduction	One-sentence description of the project's core value	P0
Feature List	Main features listed in table format	P0
Installation Instructions	Environment requirements and installation steps	P0
Usage Instructions	Quick start and basic usage	P0
License	Open-source license declaration	P0

Recommended Sections

章节	说明	适用场景
项目结构	目录树展示	中大型项目
技术栈	技术选型说明	所有项目
开发指南	本地开发、构建、贡献	开源项目
常见问题	FAQ	用户向项目
文档地址	外部文档链接	复杂项目

Section	Description	Applicable Scenarios
Project Structure	Directory tree display	Medium and large-sized projects
Tech Stack	Technology selection explanation	All projects
Development Guide	Local development, build, contribution	Open-source projects
FAQ	Frequently asked questions	User-facing projects
Documentation Links	External documentation links	Complex projects

可选章节

Optional Sections

章节	说明	适用场景
作者联系	微信、邮箱	个人项目
技术交流群	群二维码	社区项目
打赏	收款码	个人开源
项目统计	代码量、版本历史	成熟项目
路线图	未来计划	活跃项目
Star History	Star 趋势图	GitHub 项目

Section	Description	Applicable Scenarios
Author Contact	WeChat, email	Personal projects
Technical Communication Group	Group QR code	Community projects
Donation	Payment QR code	Personal open-source projects
Project Statistics	Code volume, version history	Mature projects
Roadmap	Future plans	Active projects
Star History	Star trend chart	GitHub projects

内容规范

Content Specifications

标题规范

Title Specifications

undefined

undefined

[项目名称]

[Project Name]

[一句话描述项目核心价值]

[可选：项目图标/Logo]

[可选：项目标语/Slogan]

undefined

[One-sentence description of the project's core value]

[Optional: Project icon/Logo]

[Optional: Project slogan/Slogan]

undefined

功能清单表格规范

Feature List Table Specifications

markdown

undefined

markdown

undefined

功能清单

Feature List

功能名称	功能说明	技术栈	更新时间	版本
功能1	说明	Go	2025-01-23	v1.0.0
功能2	说明	Vue	2025-01-23	v1.0.0

undefined

Feature Name	Feature Description	Tech Stack	Update Date	Version
Feature 1	Description	Go	2025-01-23	v1.0.0
Feature 2	Description	Vue	2025-01-23	v1.0.0

undefined

安装说明规范

Installation Instructions Specifications

markdown

undefined

markdown

undefined

安装说明

Installation Instructions

环境要求

Environment Requirements

Node.js 16+
Python 3.8+
Go 1.19+

Node.js 16+
Python 3.8+
Go 1.19+

安装步骤

Installation Steps

bash

undefined

bash

undefined

克隆项目

Clone the project

git clone https://github.com/user/repo.git

安装依赖

Install dependencies

npm install

配置

Configure

cp .env.example .env

启动

Start

npm run dev

undefined

npm run dev

undefined

常见问题规范

FAQ Specifications

markdown

undefined

markdown

undefined

常见问题

FAQ

<details> <summary>安装失败怎么办？</summary>

检查网络连接
尝试使用国内镜像
清理缓存后重新安装

</details> <details> <summary>如何配置 xxx？</summary>

详细配置说明...

</details> ```

<details> <summary>What to do if installation fails?</summary>

Check network connection
Try using domestic mirrors
Clear cache and reinstall

</details> <details> <summary>How to configure xxx?</summary>

Detailed configuration instructions...

</details> ```

项目类型适配

Project Type Adaptation

Web 应用项目

Web Application Projects

特有章节：

在线演示地址
技术架构图
API 文档链接
部署说明

Unique sections:

Online demo address
Technical architecture diagram
API documentation links
Deployment instructions

库/SDK 项目

Library/SDK Projects

特有章节：

快速引入（npm install、go get 等）
API 文档
示例代码
更新日志

Unique sections:

Quick integration (npm install, go get, etc.)
API documentation
Sample code
Changelog

CLI 工具项目

CLI Tool Projects

特有章节：

安装方式（Homebrew、Cargo、npm 等）
命令行参数
使用示例（命令行输出）
配置文件说明

Unique sections:

Installation methods (Homebrew, Cargo, npm, etc.)
Command-line parameters
Usage examples (command-line output)
Configuration file instructions

API 服务项目

API Service Projects

特有章节：

API 端点列表
认证方式
请求/响应示例
SDK 链接

Unique sections:

API endpoint list
Authentication methods
Request/response examples
SDK links

高级功能

Advanced Features

自动识别项目信息

Automatic Project Information Recognition

系统能自动识别：

项目类型（Web/CLI/Library/API）
主要编程语言
构建工具
包管理器
测试框架
代码规范工具

The system can automatically identify:

Project type (Web/CLI/Library/API)
Main programming language
Build tools
Package managers
Testing frameworks
Code specification tools

生成 Badge

Badge Generation

自动生成项目 Badge：

markdown

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Version](https://img.shields.io/badge/version-v1.0.0-green.svg)
![Stars](https://img.shields.io/github/stars/user/repo.svg)

Automatically generate project badges:

markdown

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Version](https://img.shields.io/badge/version-v1.0.0-green.svg)
![Stars](https://img.shields.io/github/stars/user/repo.svg)

生成 Star History

Star History Generation

markdown

undefined

markdown

undefined

Star History

如果觉得项目不错，欢迎点个 Star ⭐

[

]

undefined

If you find the project useful, please give it a Star ⭐

[

]

undefined

输出示例

Output Examples

基础模板输出

Basic Template Output

markdown

undefined

markdown

undefined

My Project

一个简洁的项目描述

A concise project description

功能清单

Feature List

功能	说明
功能A	xxx
功能B	xxx

Feature	Description
Feature A	xxx
Feature B	xxx

安装

Installation

```bash npm install ```

bash

npm install

使用

Usage

```javascript import { MyProject } from 'my-project'

const app = new MyProject() app.run() ```

javascript

import { MyProject } from 'my-project'

const app = new MyProject()
app.run()

License

MIT

undefined

MIT

undefined

完整模板输出

Complete Template Output

包含所有推荐和可选章节的完整文档。

Complete documentation including all recommended and optional sections.

模板文件

Template Files

templates/basic.md

基础项目模板，包含核心章节

Basic project template, includes core sections

templates/full.md

完整项目模板，包含所有章节

Complete project template, includes all sections

templates/library.md

库/SDK 专用模板

Template dedicated to libraries/SDKs

templates/webapp.md

Web 应用专用模板

Template dedicated to web applications

templates/cli.md

CLI 工具专用模板

Template dedicated to CLI tools

templates/api.md

API 服务专用模板

Template dedicated to API services

示例项目

Sample Projects

查看

examples/

目录获取不同类型项目的 README 示例：

```
examples/basic-readme.md
```
- 基础示例
```
examples/full-readme.md
```
- 完整示例
```
examples/library-readme.md
```
- 库示例
```
examples/webapp-readme.md
```
- Web 应用示例

Check the

examples/

directory for README examples of different project types:

```
examples/basic-readme.md
```
- Basic example
```
examples/full-readme.md
```
- Complete example
```
examples/library-readme.md
```
- Library example
```
examples/webapp-readme.md
```
- Web application example

最佳实践

Best Practices

README 撰写原则

README Writing Principles

简洁优先: 第一屏展示核心信息
图文并茂: 适当使用截图和架构图
代码高亮: 所有代码块标注语言
版本信息: 明确最低版本要求
更新及时: 随项目更新同步维护

Simplicity First: Display core information on the first screen
Combine Text and Images: Appropriately use screenshots and architecture diagrams
Code Highlighting: Label the language for all code blocks
Version Information: Clearly state minimum version requirements
Timely Updates: Maintain synchronization with project updates

图片规范

Image Specifications

使用图床或 GitHub 仓库存储
图片大小 < 500KB
推荐 PNG/JPG 格式
添加 alt 文本

Store using image hosting or GitHub repository
Image size < 500KB
Recommended PNG/JPG formats
Add alt text

链接规范

Link Specifications

使用相对路径链接内部文档
使用绝对路径链接外部资源
重要链接添加 Badge

Use relative paths to link internal documents
Use absolute paths to link external resources
Add badges to important links

故障排查

Troubleshooting

常见问题

Common Issues

Q: 生成的 README 中文乱码 A: 确保文件使用 UTF-8 编码保存

Q: 表格显示不正常 A: 检查表格对齐，确保每行列数一致

Q: 图片无法显示 A: 确认图片 URL 可访问，使用 HTTPS

Q: 目录链接跳转失败 A: 确保锚点名称与标题一致，空格替换为

Q: Garbled Chinese characters in generated README A: Ensure the file is saved with UTF-8 encoding

Q: Table display is abnormal A: Check table alignment and ensure consistent column counts in each row

Q: Images fail to display A: Confirm the image URL is accessible and use HTTPS

Q: Directory link jump fails A: Ensure anchor names match titles, replace spaces with

版本历史

Version History

v1.0.0 (2025-01-23) - 初始版本，支持基础模板生成

v1.0.0 (2025-01-23) - Initial version, supports basic template generation