Professional GitHub project README.md generator that automatically generates a documentation structure compliant with open-source community standards.
Feature Overview
This Skill can help you:
- 📝 Automatically generate standard GitHub README.md documentation
- 🎯 Automatically adjust the documentation structure based on the project type
- 📊 Generate project statistics and roadmap
- 🔗 Automatically generate Star History and Badge
- 📧 Include author contact and donation information
- ❓ Generate frequently asked questions (FAQ)
- 📚 Supports both Chinese and English
Core Features
Standard Documentation Structure
# 项目标题
项目简介/副标题
## 项目介绍
- 项目概述
- 核心功能
- 技术栈
## 功能清单
| 功能名称 | 说明 | 状态 |
|---------|------|------|
## 安装说明
### 环境要求
### 安装步骤
## 使用说明
### 快速开始
### 配置说明
### 使用示例
## 项目结构
Tech Stack
| Technology | Version | Purpose |
Documentation Address
- Feishu Docs
- Online Documentation
Development Guide
Local Development
Build and Deployment
Contribution Guide
FAQ
Tech Community Group
Welcome to join the tech community group to share your Skills and usage tips:
Author Contact
- WeChat: laohaibao2025
- Email: 75271002@qq.com
Donation
If this project is helpful to you, feel free to buy me a cup of coffee ☕
WeChat Pay
Project Statistics
Code Statistics
Version History
Roadmap
Planned Features
Optimizations
License
SPDX-License-Identifier: MIT
Star History
[Star History image]
## 使用方法
### 方式一：交互式生成
直接提出需求，系统会引导你提供必要信息：
Please generate a README.md for my project
Information to provide:
- Project Name
- Project Description
- Tech Stack
- Core Features
- Installation Steps
- Usage Examples
- Author Information
- Whether donation information is needed
### 方式二：基于现有项目自动生成
Please automatically generate README.md based on the current project
系统会自动分析：
- 项目结构（目录、文件）
- 技术栈（package.json, go.mod, pom.xml 等）
- 构建脚本（Makefile, build.sh）
- 配置文件
- 现有文档
### 方式三：使用模板快速生成
Please use [template name] to generate README
可用模板：
- `basic` - 基础模板
- `full` - 完整模板（包含所有章节）
- `minimal` - 极简模板
- `library` - 库/SDK 专用模板
- `webapp` - Web 应用模板
- `cli` - CLI 工具模板
- `api` - API 服务模板
## 文档结构说明
### 必选章节
| 章节 | 说明 | 优先级 |
|------|------|--------|
| 项目标题 | 清晰的项目名称和副标题 | P0 |
| 项目简介 | 一句话描述项目核心价值 | P0 |
| 功能清单 | 表格形式列出主要功能 | P0 |
| 安装说明 | 环境要求和安装步骤 | P0 |
| 使用说明 | 快速开始和基本用法 | P0 |
| License | 开源协议声明 | P0 |
### 推荐章节
| 章节 | 说明 | 适用场景 |
|------|------|----------|
| 项目结构 | 目录树展示 | 中大型项目 |
| 技术栈 | 技术选型说明 | 所有项目 |
| 开发指南 | 本地开发、构建、贡献 | 开源项目 |
| 常见问题 | FAQ | 用户向项目 |
| 文档地址 | 外部文档链接 | 复杂项目 |
### 可选章节
| 章节 | 说明 | 适用场景 |
|------|------|----------|
| 作者联系 | 微信、邮箱 | 个人项目 |
| 技术交流群 | 群二维码 | 社区项目 |
| 打赏 | 收款码 | 个人开源 |
| 项目统计 | 代码量、版本历史 | 成熟项目 |
| 路线图 | 未来计划 | 活跃项目 |
| Star History | Star 趋势图 | GitHub 项目 |
## 内容规范
### 标题规范
[One-sentence description of the project's core value]
[Optional: Project icon/Logo]
[Optional: Project tagline/Slogan]
### 功能清单表格规范
```markdown
## 功能清单
| 功能名称 | 功能说明 | 技术栈 | 更新时间 | 版本 |
|---------|---------|--------|----------|------|
| 功能1 | 说明 | Go | 2025-01-23 | v1.0.0 |
| 功能2 | 说明 | Vue | 2025-01-23 | v1.0.0 |
Installation Instructions Standard
## 安装说明
### 环境要求
- Node.js 16+
- Python 3.8+
- Go 1.19+
### 安装步骤
```bash
# 克隆项目
git clone https://github.com/user/repo.git
# 安装依赖
npm install
# 配置
cp .env.example .env
# 启动
npm run dev
### 常见问题规范
```markdown
## 常见问题
<details>
<summary>安装失败怎么办？</summary>
1. 检查网络连接
2. 尝试使用国内镜像
3. 清理缓存后重新安装
</details>
<details>
<summary>如何配置 xxx？</summary>
详细配置说明...
</details>
Project Type Adaptation
Web Application Project
Unique sections:
- Online Demo Address
- Technical Architecture Diagram
- API Documentation Link
- Deployment Instructions
Library/SDK Project
Unique sections:
- Quick import (npm install, go get, etc.)
- API Documentation
- Example Code
- Changelog
CLI Tool Project
Unique sections:
- Installation method (Homebrew, Cargo, npm, etc.)
- Command-line parameters
- Usage examples (command-line output)
- Configuration file description
API Service Project
Unique sections:
- API endpoint list
- Authentication method
- Request/response examples
- SDK Link
Advanced Features
Automatic Project Information Recognition
The system can automatically recognize:
- Project type (Web/CLI/Library/API)
- Main programming language
- Build tools
- Package Manager
- Testing Framework
- Code Style Tool
Generate Badge
Automatically generate project badges:
Generate Star History
## Star History
如果觉得项目不错，欢迎点个 Star ⭐
[]
Output Examples
Basic Template Output
# My Project
一个简洁的项目描述
## 功能清单
| 功能 | 说明 |
|------|------|
| 功能A | xxx |
| 功能B | xxx |
## 安装
\`\`\`bash
npm install
\`\`\`
## 使用
\`\`\`javascript
import { MyProject } from 'my-project'
const app = new MyProject()
app.run()
\`\`\`
## License
MIT
Complete Template Output
Complete documentation containing all recommended and optional sections.
Template Files
templates/basic.md
Basic project template, containing core sections
templates/full.md
Complete project template, containing all sections
templates/library.md
Library/SDK-specific template
templates/webapp.md
Web application-specific template
templates/cli.md
CLI tool-specific template
templates/api.md
API service-specific template
Example Projects
View examples/ directory to get README examples for different types of projects:
examples/basic-readme.md- Basic exampleexamples/full-readme.md- Complete exampleexamples/library-readme.md- Library exampleexamples/webapp-readme.md- Web application example
Best Practices
README Writing Principles
- Conciseness first: Show core information on the first screen
- Rich text and images: Use screenshots and architecture diagrams appropriately
- Code highlighting: Mark the language for all code blocks
- Version information: Specify minimum version requirements
- Timely updates: Maintain in sync with project updates
Image Guidelines
- Use an image hosting service or GitHub repository for storage
- Image size < 500KB
- PNG/JPG format recommended
- Add alt text
Link Guidelines
- Use relative paths to link to internal documentation
- Use absolute paths to link to external resources
- Add badges to important links
Troubleshooting
FAQ
Q: The generated README has garbled Chinese characters A: Make sure the file is saved in UTF-8 encoding
Q: The table displays incorrectly A: Check the table alignment and make sure each row has the same number of columns
Q: Images cannot be displayed A: Confirm that the image URL is accessible and use HTTPS
Q: Table of contents links fail to jump
A: Make sure the anchor name matches the heading, and replace spaces with -
Version History
- v1.0.0 (2025-01-23) - Initial version, supports basic template generation