Công cụ tạo README.md
Điền một biểu mẫu ngắn và nhận file README.md gọn gàng cho GitHub với huy hiệu, cài đặt, cách dùng, tính năng, đóng góp, giấy phép, kèm xem trước Markdown trực tiếp.
owner/repo, dùng cho huy hiệu và lệnh git clone.
Mỗi dòng một tính năng.
Tiêu đề các mục được viết bằng tiếng Anh theo thông lệ README mã nguồn mở. Nội dung bạn nhập được giữ nguyên.
Công cụ Liên quan
Xem Tất cảTạo README là gì?
README là file đầu tiên mọi người đọc trong một repository. Công cụ này biến vài trường — tên dự án, mô tả, tính năng, lệnh cài đặt và sử dụng, giấy phép và tác giả — thành một file README.md có cấu trúc rõ ràng với huy hiệu shields.io tùy chọn, mục lục và hướng dẫn đóng góp. Bạn có thể chuyển qua lại giữa mã nguồn Markdown và bản Xem trước đã hiển thị.
Cách sử dụng Tạo README
- Nhập Tên dự án và, nếu dự án ở trên GitHub, Kho GitHub dạng
owner/repo. - Thêm Khẩu hiệu một dòng, Mô tả, Tính năng (mỗi dòng một mục), Lệnh cài đặt và Ví dụ sử dụng.
- Chọn Giấy phép, thêm Tác giả, và bật/tắt huy hiệu, Mục lục và Mục đóng góp.
- Kiểm tra bản Xem trước, rồi sao chép hoặc tải xuống README.md.
Ví dụ
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Khi nào nên dùng Tạo README
Dùng để khởi tạo README cho thư viện, CLI, dự án cá nhân hoặc repository nội bộ mới chỉ trong một phút, rồi chỉnh sửa văn bản bằng tay. Công cụ tạo ra một khung hợp lý, không phải tài liệu hoàn chỉnh: bạn vẫn cần giải thích cấu hình, chi tiết API và ví dụ riêng cho dự án.
Tạo README hoạt động như thế nào
Biểu mẫu được ghép thành Markdown kiểu GitHub: một H1 chứa tên, huy hiệu tùy chọn (giấy phép, sao, issue từ img.shields.io, liên kết tới repository), một blockquote cho khẩu hiệu, sau đó là các mục Features, Installation (có khối git clone + cd khi đã đặt repository), Usage (khối mã fenced theo ngôn ngữ bạn chọn), Contributing, License và Author. Liên kết mục lục dùng quy tắc anchor tiêu đề của GitHub. Bản xem trước được hiển thị bằng marked và làm sạch bằng DOMPurify.
Các Trường Hợp Sử Dụng Phổ Biến
- Khởi tạo README cho một package mã nguồn mở mới
- Chuẩn hóa cấu trúc README giữa các repository của nhóm
- Thêm nhanh mục giấy phép và đóng góp
- Tạo README cho dự án portfolio hoặc hackathon
Câu Hỏi Thường Gặp
Công cụ có tạo cả file LICENSE không?
Không. Nó thêm một mục License liên kết tới LICENSE; hãy tự thêm nội dung giấy phép vào repository (GitHub có thể tạo giúp bạn).
Vì sao các tiêu đề lại bằng tiếng Anh?
Tiêu đề mục bằng tiếng Anh là quy ước của README mã nguồn mở và giúp người đóng góp trên toàn thế giới dễ đọc lướt dự án. Nội dung của bạn vẫn giữ nguyên ngôn ngữ bạn viết.
Huy hiệu có hoạt động với repository riêng tư không?
Shields.io không đọc được repository GitHub riêng tư, nên huy hiệu sao và issue chỉ hiển thị dữ liệu cho repo công khai.