Tập tin READ README được định dạng trên nền tảng markdown trên Github là gì?

27

Tôi không rõ định dạng là gì, nếu có yêu cầu hệ thống / dòng lệnh để tạo nó, v.v.

Về cơ bản, chỉ cần biết thông số kỹ thuật và nếu có các bước kỹ thuật để tạo tệp README.

github

— sai lầm ngớ ngẩn
nguồn

4

Không, chỉ là một tập tin văn bản mà bạn chỉnh sửa bằng tay. Đối với cú pháp, en.wikipedia.org/wiki/Markdown

— Andrea

3

định dạng wiki-chỉnh sửa tương tự mà bên này sử dụng.

— k3b

+1 @Andrea: Cảm ơn, mặc dù tôi có thể nghĩ ra nhiều hơn một số định dạng đánh dấu, định dạng và phiên bản nào được mong đợi trên Github? Ngoài ra, bạn bình luận đọc nhiều hơn một câu trả lời, xin vui lòng gửi nó như là một câu trả lời hoàn chỉnh. Một lần nữa cám ơn!

— sai lầm ngớ ngẩn

+1 @ K3b: Tin rằng bạn đang tham gia vào một cái gì đó, bạn đang nói về việc sử dụng Gollum của Github , ví dụ cho phép liên kết tương đối? Nếu vậy, xin vui lòng gửi đây là câu trả lời, vì tôi tin rằng đó là câu trả lời chính xác. Cảm ơn!

— sai lầm ngớ ngẩn

37

Markdown là một cú pháp đơn giản để cung cấp thông tin ngữ nghĩa và thể hiện định dạng phổ biến trong văn bản thuần túy. Daring Fireball có một hướng dẫn cú pháp tuyệt vời để đánh dấu tiêu chuẩn . GitHub sau đó sử dụng một biến thể của cái này mà họ gọi là GitHub Flavored Markdown .

Để thiết lập readme của bạn, chỉ cần tạo một tệp văn bản đơn giản và đặt tên là README (hoặc README.md / README.markdown) và cam kết nó vào thư mục gốc của repo của bạn. GitHub sau đó sẽ chọn cái này làm readme dự án.

— Kim Burgess
nguồn

2

Tôi cũng đã tạo một video giải thích cách sử dụng Markdown. Bạn có thể tìm thấy nó ở đây: mikemclin.net/markdown-syntax-lingu

— Mike McLin

9

Wikipedia - Markdown tham khảo trang "GitHub Flavored Markdown - Giới thiệu" ( archv. )

Trích dẫn từ trang:

GitHub sử dụng cái mà chúng ta gọi là "GitHub Flavored Markdown" (GFM) cho các tin nhắn, vấn đề và bình luận. Nó khác với Markdown tiêu chuẩn (SM) theo một số cách quan trọng và thêm một số chức năng bổ sung.

Trang này cũng đưa ra một mô tả về sự khác biệt đối với Markdown tiêu chuẩn.

Ngoài ra còn có thêm thông tin về cách Markdown thực sự được hiển thị bởi GitHub:

Nếu bạn quan tâm đến cách chúng tôi kết xuất các tệp Markdown, bạn có thể muốn xem Redcarpet , giao diện Ruby của chúng tôi đến thư viện Sundown .

(Rõ ràng, Sundown là trình phân tích cú pháp Markdown thực tế được sử dụng đằng sau màn cửa.)

Để thêm một lớp trừu tượng nữa, Sundown là một nhánh của một trình phân tích cú pháp Markdown khác :-)
Trích dẫn từ trang GitHub của Sundown :

Sundown là một trình phân tích cú pháp Markdown dựa trên mã gốc của thư viện Upskirt của Natacha Porté.

— Christian Specht
nguồn

1

Điều này rất lạ, nhưng có vẻ như GitHub không sử dụng GitHub-Flavored Markdown (GFM) khi hiển thị tệp README.

GitHub sử dụng "GitHub Flavored Markdown" hoặc GFM trên toàn trang web - trong các vấn đề, nhận xét và yêu cầu kéo.

Thay vào đó, nó dường như sử dụng một phiên bản gọi là redcarpet như một phần của dự án đánh dấu GitHub . Họ cũng hỗ trợ một số định dạng đánh dấu khác, bao gồm MediaWiki. Chỉ cần sử dụng đúng phần mở rộng tệp và GitHub sẽ hiển thị đánh dấu.

Nếu bạn muốn thấy sự khác biệt giữa hai hương vị khác nhau của Markdown, hãy đọc mô tả về GFM và các tính năng bổ sung của nó .

— Don Kirkby
nguồn

1

redcarpet và Github Flavored Markdown là hai khái niệm riêng biệt, nhưng bổ sung, không cạnh tranh thực hiện cùng một thứ. redcarpet về cơ bản là một trình biên dịch lấy những thứ được viết bằng ngôn ngữ Github Flavored Markdown và xuất ra HTML hoặc XHTML.

— 8bittree