Công cụ tạo README hồ sơ GitHub

Kết quả

Việc tạo một kho lưu trữ có tên trùng với tên người dùng GitHub của bạn sẽ mang lại một tệp README hiển thị ở đầu trang hồ sơ. Công cụ này tạo ra một tệp Markdown gọn gàng cho kho đó: tiêu đề, phần giới thiệu ngắn, bộ công nghệ và các thẻ thống kê tùy chọn chạy bằng github-readme-stats.

Cách tạo README cho hồ sơ

  1. 1

    Điền thông tin của bạn

    Tên hiển thị, khẩu hiệu, địa điểm, việc bạn đang làm và điều bạn đang học.

  2. 2

    Thêm bộ công nghệ của bạn

    Danh sách phân tách bằng dấu phẩy; mỗi mục được hiển thị dưới dạng một thẻ in đậm.

  3. 3

    Bật các thẻ thống kê

    Các thẻ GitHub Stats và Top Languages hiển thị dữ liệu trực tiếp từ github-readme-stats; tùy chọn hoạt động sẽ thêm liên kết đến biểu đồ đóng góp của bạn.

  4. 4

    Sao chép Markdown

    Tạo một kho lưu trữ có tên trùng với tên người dùng của bạn và đẩy README.md vào thư mục gốc.

Cách hoạt động của “kho đặc biệt”

Nếu tên người dùng của bạn là alex và bạn tạo một kho công khai tên là alex, GitHub sẽ hiển thị tệp README.md của kho đó trên hồ sơ của bạn (phía trên mục “Kho lưu trữ phổ biến”). Đây là một tính năng được ghi rõ trong tài liệu, không phải một mẹo lách.

Các thẻ mà công cụ có thể nhúng

Thẻ URL nguồn Ghi chú
Thống kê GitHub github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true Commit, PR, issue
Ngôn ngữ chính github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... Phân bố ngôn ngữ theo dung lượng kho
Hoạt động đóng góp github.com/{username}?tab=overview Liên kết hiển thị khi bật tùy chọn “Streak”

Hai thẻ thống kê là các điểm cuối định dạng PNG và hiển thị được trên mọi trình xem Markdown, kể cả khi ai đó mở hồ sơ của bạn mà chưa đăng nhập; liên kết hoạt động sẽ mở biểu đồ đóng góp của bạn trên GitHub.

Nội dung dễ đọc

  • Khẩu hiệu một dòng: vai trò + trọng tâm (“Kỹ sư hạ tầng Rust, quan tâm đến tracing”).
  • Tối đa 3–5 gạch đầu dòng phía trên bộ công nghệ; nhiều hơn nữa sẽ giống như chép nguyên một bản CV.
  • Kỹ năng dạng thẻ, không phải một đoạn văn. Người đọc lướt để tìm công nghệ.
  • Liên kết đến các dự án bạn thực sự duy trì. Kho bị bỏ hoang mà ghim lên hồ sơ còn tệ hơn là không có gì.
  • Một dòng liên hệ: email hoặc một tài khoản mạng xã hội duy nhất; đừng liệt kê sáu mạng.

Những thứ không nên đặt ở đó

  • Địa chỉ riêng hoặc số điện thoại.
  • Câu chào nhà tuyển dụng (“Open to work” nên đặt ở LinkedIn hoặc tùy chọn banner của GitHub).
  • Emoji ở mọi dòng, một hai cái thì ổn, cả rừng thì thành nhiễu.

Câu hỏi thường gặp

github-readme-stats được lưu trữ trên Vercel và thỉnh thoảng bị giới hạn tốc độ hoặc lưu tạm dữ liệu cũ. Nếu một thẻ bị lỗi, hãy đợi vài phút hoặc tự lưu trữ dự án, kho có nút triển khai lên Vercel chỉ với một cú nhấp.

Chỉ khi bạn xác thực dịch vụ bằng một token có phạm vi repo. Theo mặc định, thống kê chỉ tính các commit công khai, đây thường là lựa chọn phù hợp cho một hồ sơ công khai.

Có. GitHub cho phép dùng một tập con của HTML trong Markdown, <img>, <details>, <sub>, <sup> và các kiểu inline đơn giản. Script và biểu mẫu bị loại bỏ vì lý do bảo mật.

Không. Các giá trị bạn nhập sẽ được gửi đến máy chủ của chúng tôi để tạo bản xem trước và trong chế độ nhiều bước, chúng được mang theo trong liên kết trang giữa các bước. Không có gì được lưu trong cơ sở dữ liệu và mọi thứ sẽ bị hủy khi bạn đóng tab.

Công cụ liên quan

Công cụ này có phiên bản bằng các ngôn ngữ khác