ไฟล์ README ที่ฟอร์แมตมาร์กอัปใน Github คืออะไร

27

มันไม่ชัดเจนสำหรับฉันว่ารูปแบบคืออะไรหากมีข้อกำหนดระบบ / บรรทัดคำสั่งสำหรับการสร้างเป็นต้น

โดยทั่วไปเพียงแค่ต้องรู้รายละเอียดและหากมีขั้นตอนทางเทคนิคในการสร้างไฟล์ README

github

— ความผิดพลาด
แหล่งที่มา

4

ไม่เพียงไฟล์ข้อความที่คุณแก้ไขด้วยมือ สำหรับไวยากรณ์นั้นen.wikipedia.org/wiki/Markdown

— Andrea

3

มันเป็นรูปแบบ wiki-edit-format ที่ฝั่งนี้ใช้

— k3b

+1 @Andrea: ขอบคุณแม้ว่าฉันจะสามารถคิดได้มากกว่าหนึ่งรูปแบบมาร์กอัปซึ่งคาดว่าจะจัดรูปแบบและเวอร์ชันใดใน Github นอกจากนี้คุณแสดงความคิดเห็นอ่านเป็นคำตอบเพิ่มเติมกรุณาโพสต์มันเป็นคำตอบที่สมบูรณ์ ขอบคุณอีกครั้ง!

— ความผิดพลาด

+1 @ K3b: เชื่อว่าคุณกำลังทำอะไรอยู่คุณกำลังพูดถึงการใช้Gollumของ Github ตัวอย่างเช่นอนุญาตให้มีการเชื่อมโยงแบบสัมพันธ์หรือไม่ ถ้าเป็นเช่นนั้นโปรดโพสต์สิ่งนี้เป็นคำตอบเพราะฉันเชื่อว่านั่นเป็นคำตอบที่ถูกต้อง ขอบคุณ!

— ความผิดพลาด

37

Markdown เป็นไวยากรณ์ง่าย ๆ สำหรับการให้ข้อมูลความหมายและแสดงถึงการจัดรูปแบบทั่วไปในข้อความธรรมดา Daring Fireball มีน่ากลัวคู่มือไวยากรณ์สำหรับ markdown GitHub แล้วใช้แตกต่างจากที่พวกเขาเรียกGitHub รส Markdown

ในการตั้งค่า readme ของคุณเพียงแค่สร้างไฟล์ข้อความธรรมดาและตั้งชื่อ README (หรือ README.md / README.markdown) และส่งไปยังรากของ repo ของคุณ GitHub จะเลือกสิ่งนี้เมื่อโครงการ readme

— คิมเบอร์เจส
แหล่งที่มา

2

ฉันยังสร้างวิดีโอที่อธิบายวิธีใช้ Markdown คุณสามารถค้นหาได้ที่นี่: mikemclin.net/markdown-syntax-language

— Mike McLin

9

Wikipedia - Markdownอ้างอิงหน้า"GitHub Flavoured Markdown - บทนำ" ( archv. )

อ้างอิงจากหน้า:

GitHub ใช้สิ่งที่เราเรียกว่า "GitHub Flavoured Markdown" (GFM) สำหรับข้อความปัญหาและความคิดเห็น มันแตกต่างจาก Markdown มาตรฐาน (SM) ด้วยวิธีการที่สำคัญสองสามประการและเพิ่มฟังก์ชั่นเพิ่มเติมบางอย่าง

หน้านี้ยังให้คำอธิบายถึงความแตกต่างของ Markdown มาตรฐาน

นอกจากนี้ยังมีข้อมูลเพิ่มเติมเกี่ยวกับวิธีการแสดงผล Markdown จริง ๆ โดย GitHub:

หากคุณกำลังสนใจในวิธีการที่เราทำให้ไฟล์ Markdown คุณอาจต้องการที่จะตรวจสอบRedCarpetอินเตอร์เฟซทับทิมของเราที่จะSundownห้องสมุด

(เห็นได้ชัดว่า Sundown เป็นตัวแยกวิเคราะห์จริงของ Markdown ที่ใช้หลังม่าน)

ในการเพิ่มเลเยอร์สิ่งที่เป็นนามธรรมอีกชั้นหนึ่ง Sundown เป็นทางแยกของตัวแยกวิเคราะห์มาร์คดาวน์อื่น :-)
อ้างอิงจากหน้า GitHub ของ Sundown :

Sundown เป็นตัวแยกวิเคราะห์ Markdown ตามรหัสต้นฉบับของไลบรารีUpskirtโดย Natacha Porté

— คริสเตียนสเปชต์
แหล่งที่มา

1

มันแปลกมาก แต่ดูเหมือนว่า GitHub จะไม่ใช้GitHub-Flavoured Markdown (GFM)เมื่อเรนเดอร์ไฟล์ README

GitHub ใช้ "GitHub Flavoured Markdown" หรือ GFM ทั่วทั้งไซต์ - ในประเด็นความคิดเห็นและคำขอดึง

แต่มันดูเหมือนว่าจะใช้รุ่นที่เรียกว่า RedCarpet เป็นส่วนหนึ่งของโครงการมาร์กอัป GitHub พวกเขายังสนับสนุนรูปแบบมาร์กอัปอื่น ๆ อีกหลายรูปแบบรวมถึง MediaWiki เพียงใช้นามสกุลไฟล์ที่ถูกต้องและ GitHub จะแสดงผลมาร์กอัป

หากคุณต้องการที่จะเห็นความแตกต่างระหว่างสองรสชาติที่แตกต่างกันของ Markdown ที่อ่านรายละเอียดของ GFMและคุณสมบัติพิเศษของมัน

— ดอน Kirkby
แหล่งที่มา

1

redcarpet และ Github Flavoured Markdown นั้นแยกกันสองแนวคิด แต่เป็นแนวคิดที่เสริมเข้าด้วยกัน redcarpet นั้นเป็นคอมไพเลอร์ที่ใช้สิ่งที่เขียนในภาษา Github Flavoured Markdown และแสดงผล HTML หรือ XHTML

— 8bittree