ไฟล์ใดที่ใช้นามสกุล. md และฉันควรจะแก้ไขอย่างไร

878

บน GitHub หลายโครงการมีREADME.mdไฟล์ ดูเหมือนว่าไฟล์รูปแบบง่าย ๆ ในการแสดงข้อความและรูปภาพ

ฉันเดาว่ามีคำอธิบายแก้ไขหรือไวยากรณ์ที่ไหนสักแห่ง

ฉันจะหาคำแนะนำเกี่ยวกับ.mdไฟล์ได้ที่ไหน

markdown  file-extension 
— ลายหยูหวน
แหล่งที่มา
38
ฉันเดาว่านี่เป็นหลักฐานสนับสนุนการใช้.markdownส่วนขยายแทน แต่มันยาวมาก ...
— endolith
7
นี่คือลิงค์ที่อาจช่วยคุณ -> .MD ไฟล์นามสกุล
— Vipin Kr ซิงห์
1
MarkPadเป็นแอปพลิเคชั่นที่ดีสำหรับการแก้ไข MarkDown ใน Windows มันนำเสนอคุณด้วยตัวอย่างของการแก้ไข
— skjoshi
1
ผู้ใช้สามารถลองMarkViewซึ่งเป็นส่วนเสริมของ Chrome สำหรับการแก้ไขและดูไฟล์ markdown ภายในเบราว์เซอร์
— swcool
1
คู่มือเต็มรูปแบบที่จะช่วยให้คุณเริ่มต้นด้วยmarkdown: blog.wax-o.com/2014/04/... คุณควรพยายามเขียน markdown ด้วยวิธีการแสดงผลภาพสด (ด้วยแอปพลิเคชันเช่นmouapp.com ) คุณรู้ไหมว่าการโพสต์สแต็คโอเวอร์โฟลว์และไวยากรณ์ความคิดเห็นนั้นอิงจาก markdown? :) stackoverflow.com/editing-help
— fabien

คำตอบ:

732

Markdown เป็นรูปแบบไฟล์ข้อความธรรมดา ส่วนขยาย.mdและ.markdownเป็นเพียงไฟล์ข้อความที่เขียนในไวยากรณ์Markdown หากคุณมีReadme.mdrepo อยู่ GitHub จะแสดงเนื้อหาในหน้าแรกของ repo ของคุณ อ่านเอกสาร:

คุณสามารถแก้ไขReadme.mdไฟล์ใน GitHub เอง คลิกที่ Readme.md คุณจะพบปุ่มแก้ไข คุณสามารถดูตัวอย่างการเปลี่ยนแปลงของคุณและยอมรับได้

เนื่องจากเป็นไฟล์ข้อความ, Notepad หรือ Notepad ++ (Windows), TextEdit (Mac) หรือโปรแกรมแก้ไขข้อความอื่น ๆ สามารถใช้ในการแก้ไขและปรับเปลี่ยนได้ มีเครื่องมือแก้ไขพิเศษที่แยกวิเคราะห์มาร์กอัปโดยอัตโนมัติขณะที่คุณพิมพ์และสร้างตัวอย่างในขณะที่คนอื่นใช้การระบายสีไวยากรณ์และการตกแต่งต่าง ๆ กับข้อความที่แสดง ในทั้งสองกรณีแม้ว่าไฟล์ที่บันทึกไว้จะยังคงเป็นไฟล์ข้อความที่สามารถอ่านได้

หากคุณต้องการที่จะสร้างmdไฟล์ที่มีการแสดงตัวอย่างและถ้าคุณไม่ต้องการที่จะติดตั้งบรรณาธิการพิเศษใด ๆ คุณสามารถใช้บรรณาธิการออนไลน์เช่นdillinger.ioและstackedit.io พวกเขาให้ตัวอย่างสด คุณสามารถส่งออกไฟล์ไปยังGoogle DriveหรือDropboxได้

— Dikei
แหล่งที่มา
27
ฉันพบว่าคำอธิบายพื้นฐานของ Github มีประโยชน์อย่างมากในการแนะนำอย่างรวดเร็วเช่นกัน
— Voo
2
บน Windows คุณอาจต้องการใช้ WordPad เพื่อใช้การจัดรูปแบบเพื่อให้อ่านง่ายขึ้น
— G O'Rilla
4
@ GO'Rilla, IMHO หลีกเลี่ยง WordPad เช่นกาฬโรคเว้นแต่เขียนโน้ตเล็ก ๆ น้อย ๆ ให้กับตัวเองว่าคุณจะไม่แชร์กับใครเลย สิ่งที่เพิ่มลงในไฟล์. txt สามารถสร้างความหายนะให้กับโปรแกรมแก้ไขอื่น ๆ (vim, Notepad ++ เป็นต้น) ทำงานกับข้อความธรรมดาได้ดีกว่าเมื่อใช้. txt และใช้โปรแกรมประมวลผลคำหรือ Acrobat สำหรับไฟล์ข้อความ. txt ที่ไม่ใช่เช่น. doc และ. pdf
— เขาวงกต
1
เราสามารถเพิ่มรูปภาพหรือลิงค์ในไฟล์. md ได้หรือไม่?
— Raphael
1
@ user1645290 ใช่มันเป็นไปได้ ดู
— B-GangsteR
87

หากคุณกำลังมองหาการแก้ไขผมขอแนะนำให้คุณใช้http://dillinger.io/ มันเป็นโปรแกรมแก้ไขข้อความบนเบราว์เซอร์ที่สามารถแสดง Markdown ได้ทันที

อย่างไรก็ตามหากคุณต้องการแอพและคุณใช้ OS X คุณสามารถลองใช้Mouได้ มันค่อนข้างดีและเต็มไปด้วยตัวอย่าง

— sirLisko
แหล่งที่มา
2
ดูเหมือนว่าจะกลับมามีชีวิตอีกครั้ง?
— GuiSim
5
ฉันต้องการแนะนำhttp://dillinger.io/โปรแกรมแก้ไขข้อความบนเบราว์เซอร์สุดเจ๋งอีกตัว นอกจากนี้ยังให้คุณเชื่อมโยง Dropbox, Github และ Google ไดรฟ์
— sirLisko
ลิงก์ Notepad ในคำตอบนี้จะทำให้เกิดการดาวน์โหลดไฟล์ RAR ทำไมไม่มีหน้าเว็บคุณไม่บอกว่ามันเป็นตัวแก้ไขเบราว์เซอร์?
— evanrmurphy
ลิงค์นั้นใช้ไม่ได้อีกต่อไปแล้ว
— Carlos Pliego
เพียงแค่ชี้ให้เห็นว่านี่ไม่ใช่คำตอบที่สมบูรณ์ของคำถาม คุณไม่ได้อธิบายว่า. md คืออะไรเพียงแก้ไขได้อย่างไร
— Zoe
44

โปรแกรมแก้ไขข้อความ Atomของ Github มีโหมดแสดงตัวอย่างแบบสดสำหรับไฟล์มาร์กอัป

CTRL+SHIFT+Mแป้นพิมพ์ลัดคือ

มันสามารถใช้งานได้จากการแก้ไขโดยใช้CTRL+SHIFT+Mคีย์ผูกพันและเปิดใช้งานอยู่ในขณะนี้สำหรับ.markdown, .md, .mkd, .mkdownและ.ronไฟล์

ป้อนคำอธิบายรูปภาพที่นี่

— Feckmore
แหล่งที่มา
33

โปรแกรมแก้ไขข้อความVisual Studio Codeของ Microsoft ได้สร้างขึ้นเพื่อรองรับไฟล์. md ที่เขียนด้วยไวยากรณ์ markdown

ไวยากรณ์ถูกกำหนดรหัสสีโดยอัตโนมัติภายในไฟล์. md และหน้าต่างแสดงตัวอย่างของ markdown ที่แสดงผลสามารถดูได้โดยการกดShift+Ctrl+V(Windows) หรือShift+Cmd+V(Mac)

หากต้องการดูแบบเคียงข้างกันให้ลากแท็บตัวอย่างไปทางด้านขวาของเครื่องมือแก้ไขหรือใช้Ctrl+K V(Windows) หรือCmd+K V(Mac) แทน

ป้อนคำอธิบายรูปภาพที่นี่

VS รหัสใช้ห้องสมุดที่ทำเครื่องหมายไว้สำหรับการแยกและมีGithub รส Markdownการสนับสนุนการใช้งานโดยค่าเริ่มต้น แต่มันจะไม่แสดงแบบอินไลน์ Github Emoji เช่น Github ของโปรแกรมแก้ไขข้อความ Atomไม่

นอกจากนี้ VS Code ยังรองรับปลั๊กอินมาร์คดาวน์หลายรายการสำหรับการใช้งานเพิ่มเติม

— Feckmore
แหล่งที่มา
หากคุณใช้ Visual Studio 2015 แทนดูคำตอบของฉันด้านล่าง
— bytedev
1
หมายเหตุ - คุณสามารถคลิกขวาที่ไฟล์ readme> open preview
— Chris Halcrow
15

นามสกุล ' .md ' หมายถึงไฟล์Markdown

หากคุณไม่ต้องการติดตั้งแอพเพื่ออ่านในรูปแบบนั้นคุณสามารถใช้TextEditหรือXcodeเพื่อเปิดใน Mac

ในระบบปฏิบัติการอื่น ๆ คุณควรจะสามารถเปิดได้โดยใช้โปรแกรมแก้ไขข้อความใด ๆแม้ว่าตามที่คาดไว้คุณจะไม่เห็นมันในรูปแบบMarkdown

— codeburn
แหล่งที่มา
4
ที่จริงแล้วคุณจะเห็นมันในรูปแบบ Markdown คุณจะไม่เห็นว่าเป็นตัวหนาตัวเอียงตัวเอียงและบล็อกโค้ด
— Lightness Races ที่ Orbit
14

Yup เพียงGitHub รส Markdown การรวมไฟล์ README ในที่เก็บของคุณจะช่วยให้ผู้อื่นทราบได้อย่างรวดเร็วว่ามันเกี่ยวกับอะไรและจะติดตั้งอย่างไร มีประโยชน์มากที่จะรวมไว้ใน repos ของคุณ

— esilvas
แหล่งที่มา
5
downvoted โดย "หนึ่ง" ใน "รวมถึงหนึ่งในพื้นที่เก็บข้อมูลของคุณ" คุณควรหมายถึง "ไฟล์ README ในรูปแบบใด ๆ " ไม่เพียงแค่ "ไฟล์ README.md" แต่คำถามนั้นถามเกี่ยวกับไฟล์“ .md” โดยทั่วไปไม่ใช่เกี่ยวกับ README โดยทั่วไป ดังนั้นคำตอบนี้ไม่เกี่ยวข้องกับคำถาม นอกจากนี้ความคลุมเครือของ "หนึ่ง" อาจทำให้ผู้อ่านคิดว่า Markdown README จำเป็นต้องดีกว่า README อื่น ๆ ซึ่งผิด
— Rory O'Kane
1
ฉันทำการเปลี่ยนแปลงที่ระบุไว้ในความคิดเห็นก่อนหน้านี้เพราะมันสมเหตุสมผลและฉันคิดว่ามันสามารถช่วยหลีกเลี่ยงความสับสน ฉันไม่คิดว่านี่เป็นคำตอบที่ดีมากเพราะไม่มีอะไรใหม่ที่เกี่ยวข้อง คำถามนี้ไม่เกี่ยวกับ README แต่เกี่ยวกับ. md ส่วนขยาย ไม่มีเหตุผลที่จะเพิ่มคำตอบนี้หกสัปดาห์หลังจากคำตอบที่ยอมรับให้ข้อมูลเดียวกัน
— Erick Robertson
5

Markdown เป็นเพียงแฟ้มข้อความที่เลือกมี.mdหรือ.markdownส่วนขยาย มันสามารถแปลงเป็น HTML หากต้องการทราบว่าไวยากรณ์ของ Markdown เป็นอย่างไร

GitHub รส Markdown

คุณสามารถใช้โปรแกรมแก้ไขข้อความเพื่อทำเครื่องหมาย หากคุณเป็นsublime textผู้ใช้คุณสามารถตรวจสอบMarkdown Previewปลั๊กอินที่จะแสดงเนื้อหา markdown ที่แสดงผลในเบราว์เซอร์และการปรับปรุงทุกครั้งที่คุณเปลี่ยนไฟล์ markdown

เครื่องมือแก้ไข markdown ออนไลน์บางส่วน

— Fizer Khan
แหล่งที่มา
3

ผมขอแนะนำให้StackEdit มันเป็นโปรแกรมแก้ไข WISIWIG ง่าย คุณสามารถใช้ทั้งเอดิเตอร์และไวยากรณ์ มีซินแทกช่วยในการทำเครื่องหมายอย่างรวดเร็ว เลิกทำ / ทำซ้ำความคิดเห็น GoogleDrive การเชื่อมต่อ Dropbox

— Romeno
แหล่งที่มา
2

มีความพยายามอย่างต่อเนื่องที่จะทำให้มาตรฐานมาร์ดาวน์เป็นตอนนี้น่าจะเป็นสถานที่ที่ดีที่สุดในการเรียนรู้เกี่ยวกับมาร์กอัป:

http://standardmarkdown.com/

— H ทึบ
แหล่งที่มา
2
— JeffRSon ใน
2

หากคุณกำลังสร้างไฟล์. md สำหรับโซลูชัน. NET ของคุณฉันขอแนะนำตัวแก้ไข Markdownส่วนขยายของ Visual Studio 2015 เนื่องจากมีแผงตัวอย่างเพื่อให้คุณสามารถเห็นการเปลี่ยนแปลงของคุณแบบเรียลไทม์

แก้ไข : ตอนนี้ควรทำงานกับ Visual Studio 2017 ด้วย

— bytedev
แหล่งที่มา
0

สิ่งที่ง่ายที่สุดที่จะทำถ้าคุณไม่มีเครื่องอ่านคือการเปิดไฟล์ MD ด้วยโปรแกรมแก้ไขข้อความแล้วเขียนไฟล์ MD เป็นไฟล์ HTML จากนั้นดับเบิลคลิกเพื่อดูด้วยเบราว์เซอร์

— richardwendrock
แหล่งที่มา
วิธีนี้จะใช้งานได้หากคุณมีปลั๊กอินที่อ่านไฟล์. md เท่านั้น
— แบรดบรูซ
0

. md ย่อมาจาก Markdown Text โดยทั่วไปไฟล์ข้อความอีกประเภทหนึ่งเช่น. txt

ฉันใช้ Notepad ++ เพื่ออ่านและแก้ไขสิ่งเหล่านี้

— NocFenix
แหล่งที่มา
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.