โปรแกรมดู Markdown ผ่าน Command-line สำหรับการทำงานในคอนโซล Windows
mdr, โดย michaelsanford, เป็นยูทิลิตี้บรรทัดคำสั่ง Windows ที่เรนเดอร์ Markdown ภายในคอนโซลเพื่อการดูไฟล์อย่างรวดเร็ว มันทำการวิเคราะห์ Markdown และเรนเดอร์หัวเรื่อง ย่อหน้า รายการ และการเน้นแบบอินไลน์เป็นผลลัพธ์ในเทอร์มินัลที่มีสีและรูปแบบเพื่อให้ไฟล์ README และเอกสารแสดงผลโดยไม่ต้องออกจากเชลล์ มันสามารถรับรู้บล็อกโค้ดในรูปแบบพื้นฐาน ใช้การจัดรูปแบบ ANSI และทำงานโดยไม่ต้องตั้งค่าเพื่อการดูตัวอย่างอย่างรวดเร็ว มีจุดมุ่งหมายสำหรับนักพัฒนาซอฟต์แวร์ วิศวกร DevOps และผู้ใช้พลังที่มุ่งเน้นเทอร์มินัล.
เครื่องมือทำงานร่วมกับเชลล์ Windows มาตรฐานอย่างไร
เครื่องมือทำงานจากเชลล์และรับพารามิเตอร์เส้นทางไฟล์เพื่อให้คุณสามารถดูตัวอย่างเอกสารโดยไม่ต้องเปิดโปรแกรมแยกต่างหาก รองรับทั้ง Windows CMD และ PowerShell ซึ่งทำให้การเรนเดอร์อยู่ในเวิร์กโฟลว์เดียวกันที่คุณแก้ไขหรือตรวจสอบที่เก็บข้อมูล การเรียกใช้งานนั้นง่าย: ส่งเส้นทางไฟล์ Markdown ไปยัง CLI เพื่อแสดงผลลัพธ์ที่จัดรูปแบบทันที ตัวอย่างการใช้งานรวมถึงการดู README.md ก่อนการคอมมิต
สิ่งที่เรนเดอร์ผลิตและข้อจำกัดสำหรับบล็อกโค้ด
เรนเดอร์ตีความองค์ประกอบ Markdown หลักและใช้ ANSI escape sequences สำหรับสีและการเน้นเสียง ผลลัพธ์ที่ได้คือการนำเสนอที่เป็นเนทีฟในคอนโซลแทนที่จะเป็น HTML มันมุ่งเน้นไปที่การเรนเดอร์เชิงโครงสร้าง ดังนั้นบล็อกโค้ดจึงปรากฏในรูปแบบบล็อกที่อ่านได้ แต่การเน้นไวยากรณ์เฉพาะภาษานั้นไม่รับประกันและอาจแตกต่างกันไปตามการสร้าง คาดหวังโครงสร้างที่อ่านได้ แทนที่จะเป็นการเน้นที่เหมาะสำหรับโปรแกรมแก้ไขและสามารถปรับธีมได้
ข้อกำหนดในการทำงานและพฤติกรรมของระบบที่คาดหวัง
เครื่องมือมุ่งเป้าไปที่ Windows และต้องการสภาพแวดล้อมการทำงานของ .NET ที่เข้ากันได้ ดังนั้นจึงต้องมีการทำงานที่ตรงกันเพื่อให้สามารถดำเนินการได้ เนื่องจากมันทำงานในกระบวนการในคอนโซล จึงหลีกเลี่ยงการเปิดเบราว์เซอร์หรือผู้ดู GUI และยังคงอยู่ภายในเซสชันเทอร์มินัล การดำเนินการถูกอธิบายว่าเป็นอินเทอร์เฟซบรรทัดคำสั่งที่เบา ซึ่งเหมาะสำหรับการดูตัวอย่างอย่างรวดเร็วในระหว่างการพัฒนา
ใครได้รับประโยชน์มากที่สุดและข้อควรระวังในการปฏิบัติที่ควรพิจารณา
นักพัฒนาที่มุ่งเน้นเทอร์มินัล วิศวกรปฏิบัติการ และผู้ใช้ที่มีความชำนาญซึ่งเก็บเอกสารไว้ข้างเชลล์ของตนจะได้รับประโยชน์มากที่สุดจากแนวทางนี้ โครงการนี้เป็นโอเพนซอร์สบน GitHub ซึ่งอนุญาตให้ตรวจสอบและมีส่วนร่วมจากชุมชน โปรดทราบว่าความเข้ากันได้ของ ANSI ในเทอร์มินัลจะแตกต่างกันไปตามเชลล์และเซสชันระยะไกล และผู้ใช้ที่ไม่คุ้นเคยกับเครื่องมือคอนโซลอาจต้องใช้เวลาในการรวมเวิร์กโฟลว์เข้ากับนิสัยของโปรแกรมแก้ไขและบรรทัดคำสั่งของตนเอง
ตัวเลือกที่เน้นการใช้งานในเทอร์มินัลสำหรับการตรวจสอบเอกสารอย่างรวดเร็ว
mdr เป็นตัวเลือกที่ใช้ได้จริงสำหรับผู้ใช้ที่ทำงานในคอนโซล Windows และต้องการเข้าถึงเนื้อหา Markdown ทันที มันช่วยลดการเปลี่ยนบริบทโดยการแสดงเอกสารที่จัดรูปแบบไว้ในบรรทัด แต่ไม่สามารถแทนที่เรนเดอร์ GUI ที่มีฟีเจอร์ครบถ้วนสำหรับการนำเสนอหรือการพิมพ์ได้ เคล็ดลับ: ใช้เครื่องมือนี้ร่วมกับโปรแกรมแก้ไขเทอร์มินัลของคุณสำหรับการตรวจสอบ README แบบทันที แนะนำให้ใช้.
ข้อดี
- เรนเดอร์ Markdown โดยตรงภายใน CMD และ PowerShell
- ใช้การจัดรูปแบบ ANSI สำหรับการแสดงผลในเทอร์มินัลที่มีสีและโครงสร้าง
- ทำงานโดยไม่ต้องตั้งค่าเพื่อดูตัวอย่างไฟล์ทันที
- โครงการโอเพนซอร์สที่โฮสต์บน GitHub สำหรับการตรวจสอบ
ข้อเสีย
- การเน้นโค้ดเฉพาะภาษาไม่ได้รับการจัดเตรียมอย่างสม่ำเสมอ
- ต้องการ .NET runtime ที่เข้ากันได้เพื่อดำเนินการ
- การแสดงผลสีขึ้นอยู่กับการสนับสนุน ANSI ของเทอร์มินัล
