2013-08-02 27 views
7

Điều này đã là một bí ẩn đối với tôi trong một thời gian và vì một lý do nào đó Google không giúp tôi, vì vậy hãy để tôi hỏi.GitHub có hương vị Markdown (GFM) thực sự được sử dụng trong GitHub?

EDIT: ok, tôi hiểu GFM ở khắp mọi nơi trong GitHub và tại sao chỉnh sửa dòng kiểu GFM không khả dụng? Nó có bị tắt không? và tôi biết quy tắc MD ban đầu. Điều tôi muốn xác nhận ở đây là quy tắc ngắt dòng GFM. Cảm ơn bạn.

Tôi thích GFM rất nhiều đặc biệt là cho cách ngắt dòng thẳng. https://help.github.com/articles/github-flavored-markdown Tuy nhiên, tôi chưa bao giờ có thể đăng Đánh dấu của riêng mình bằng chế độ mã vạch này.

Ví dụ, tôi đã sao chép một số danh sách cú pháp MD sang một trang mới của một trong wiki của tôi trên GitHub.

https://github.com/kenokabe/kenokabe.github.io/wiki/MarkDownGFM

Khi bạn có thể xác nhận nguồn MD.

This is intended as a quick reference and showcase. 
For more complete info, see [John Gruber's original spec] 

một dòng mới được áp dụng; tuy nhiên, kết quả không có dòng mới.

Tôi bỏ lỡ điều gì? GitHub Flavored Markdown (GFM) được sử dụng trong GitHub ở đâu?

(Chú thích chuyên môn: Markdown Ở đây sử dụng GFM ngắt dòng, do đó không cần phải sử dụng hai không gian ngắt dòng MD.)

Nó chắc chắn nói như vậy, nhưng tôi thấy md này sử dụng cách 2 không gian BR .

+0

Bạn có thể muốn thay đổi tiêu đề của câu hỏi để phản ánh nội dung mới của câu hỏi. –

Trả lời

10

Trái với những câu trả lời khác, GFM là chỉ sử dụng nơi văn bản là chỉ nhập thông qua website GitHub, không phải trong README.md và không phải trên GitHub Wiki.

Từ https://help.github.com/articles/github-flavored-markdown (nhấn mạnh thêm)

GitHub sử dụng những gì chúng ta đang gọi điện thoại "GitHub Flavored Markdown" (GFM) cho điệp, vấn đềcomments.

Lý do đằng sau điều này là README.md và Wikis là một phần của kho Git, và do đó có thể được sao chép bên ngoài trang web, nơi mà người ta mong đợi hợp lý (tiêu chuẩn) Đánh dấu thay vì GFM.

Để biết thêm về lý do GitHub, xem https://github.com/github/markup/issues/208#issuecomment-24927799

Edit:

nghệ đánh dấu màu (Pygments) tách biệt với GFM, trong đó, GFM sử dụng làm nổi bật cú pháp, tuy nhiên sự hiện diện của làm nổi bật cú pháp không đòi hỏi GFM, do đó tại sao các trang GitHub sẽ sử dụng dấu ngắt dòng tiêu chuẩn Markdown: nó sử dụng Pygments, nhưng không sử dụng GFM.

+0

Cảm ơn. Đó là những gì tôi nghĩ và muốn xác nhận. Trong thực tế, tôi đã lên kế hoạch để làm cho một số trang như https://github.com/substack/stream-handbook cho đầu ra cho riêng tôi, nhưng thấy khó để chỉnh sửa với ngắt dòng không GFM, vì vậy. Tôi kết thúc với việc phát triển Hệ thống quản lý nội dung của riêng mình. –

0

Được sử dụng khi bạn hiển thị tệp README.md trên trang chủ của kho lưu trữ, for example. Ngoài ra, khi bạn thêm ý kiến ​​đó là GFM.

+1

Nó cũng được sử dụng cho 'Trang Github' và có thể được diễn dịch bằng' Jekyll' và được dịch sang html. WAY đẹp hơn viết html thẳng, IMO. – Houdini

+1

@ Houdini, vâng, hầu như ở khắp mọi nơi trên trang web, phải không? –

+0

https://github.com/kenokabe/heroku-buildpack-nodejs/blob/master/README.md Đây là một số README.md của tôi và tôi đã thử Hello/nWorld ngay từ đầu. Không có ngắt dòng, tôi hiểu. Tôi nhớ gì? –

0

github markdown hương vị được sử dụng trên:

  • tập tin readme của repo của bạn
  • bất kỳ tập tin .md trong repo của bạn
  • vấn đề
  • wiki & trang

và tối thiểu trên nhận xét (cam kết, yêu cầu kéo, v.v.)

lưu ý về các vấn đề: có vẻ như nó sử dụng phiên bản giới hạn GFM hơn là trên các trang wiki hoặc tệp readme.

+0

Cảm ơn bạn @xero, bạn có bất kỳ ý tưởng nào tại sao phong cách phá vỡ dòng GFM cụ thể không được áp dụng cho họ? –

+1

np. không, tôi không chắc lắm. cho ý kiến ​​tôi giả sử nó cho cùng một lý do tại sao họ không cho phép nhiều dòng ý kiến ​​ở đây. nó là ok trong bối cảnh câu trả lời, nhưng không phải là bối cảnh bình luận. – xero

Các vấn đề liên quan