สร้าง Markdown ใน C#

วิธีสร้าง Markdown ใน C#

Markdown เป็นภาษามาร์กอัปอย่างง่ายที่ให้คุณจัดรูปแบบข้อความธรรมดาได้ ไลบรารี Aspose.HTML for .NET เป็นโซลูชันแบบสแตนด์อโลนที่ให้คุณแยกวิเคราะห์และจัดการไฟล์ Markdown โดยไม่ต้องใช้ซอฟต์แวร์อื่น คุณสามารถสร้างเอกสาร Markdown ตั้งแต่เริ่มต้น เปิดจากไฟล์ในเครื่อง และจัดการโดยการแทรกองค์ประกอบใหม่ ลบ หรือแก้ไขเนื้อหาของโหนดที่มีอยู่
เนมสเปซ Aspose.Html.Toolkit.Markdown.Syntax มีคลาสและเมธอดในการจัดการแผนผังไวยากรณ์ Markdown ตามข้อกำหนดของ GitHub Flavoured Markdown (GFM)
เนมสเปซ Aspose.Html.Toolkit.Markdown.Parser มีคลาสและเมธอดเพื่อให้การแยกวิเคราะห์และการแสดงผล Markdown แบบเต็ม
เนมสเปซ Aspose.Html.Toolkit.Markdown.Extensions มีคลาสและวิธีการจัดการแผนผังไวยากรณ์ Markdown ตามข้อกำหนดที่ไม่ได้เป็นส่วนหนึ่งของข้อกำหนด GFM

จะสร้าง Markdown จาก Scratch ใน C# ได้อย่างไร

การใช้ไลบรารี C# คุณสามารถสร้างไฟล์ MD โดยทางโปรแกรมได้ มาดูวิธีสร้าง Markdown ตั้งแต่เริ่มต้น

    // Create the MarkdownSyntaxTree
    var md = new MarkdownSyntaxTree(new Configuration());

    // Use the SyntaxFactory property to get the factory for creating the Markdown syntax tree
    var mdf = md.SyntaxFactory;

    var heading2 = mdf.AtxHeading("How to create Markdown from scratch in C#?", 2);

    // Add the  headers to the Markdown syntax tree
    md.AppendChild(heading2);

    // Create and add newLineTrivia element for an empty line after heading1 
    var newLineTrivia = mdf.NewLineTrivia();
    heading2.GetTrailingTrivia().Add(newLineTrivia);

    // Create an empty paragraph
    var paragraph = mdf.Paragraph();

    // Add texts to the paragraph
    paragraph.AppendChild(mdf.Text("First, add an Aspose.HTML for .NET library reference to your C# project."));

    // Add a space after the first sentence in the paragraph through a special WhiteSpace node
    paragraph.AppendChild(mdf.Whitespace());

    paragraph.AppendChild(mdf.Text("Create the MarkdownSyntaxTree. Then use the SyntaxFactory property to get a syntax factory to create new elements."));

    // Add the filled paragraph into MD document
    md.AppendChild(paragraph);

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "document.md");

    // Save MD file
    md.Save(savePath);

ขั้นตอนในการสร้าง Markdown ใน C#

มาดูขั้นตอนง่ายๆ ในการสร้าง Markdown ตั้งแต่เริ่มต้น สองขั้นตอนแรกจำเป็นสำหรับการสร้าง Markdown ขั้นตอนต่อไปคือการเพิ่มองค์ประกอบใหม่และบันทึกเอกสาร:

1. สร้าง MarkdownSyntaxTree โดยใช้ MarkdownSyntaxTree() ตัวสร้าง
2. ใช้คุณสมบัติ SyntaxFactory เพื่อรับโรงงานสำหรับสร้างแผนผังไวยากรณ์ Markdown
3. สร้างและเพิ่มองค์ประกอบใหม่ลงในไฟล์ Markdown
4. บันทึกไฟล์ MD ที่สร้างขึ้นโดยใช้เมธอด Save()

วิธีเปิดไฟล์ MD ใน C#

ตัวอย่างรหัส C# ต่อไปนี้แสดงวิธีการเปิดเอกสาร MD ที่มีอยู่:

    // Specify the path to the source MD file
    var input = "C:/temp/input.md";

    // Create a MarkdownParser object
    var parser = new MarkdownParser();

    // Parse the MD document and get a syntax tree
    var markdown = parser.ParseFile(input);

    // Work with Markdown document

    // Prepare a path for MD file saving 
    string savePath = Path.Combine(OutputDir, "output.md");

    // Save MD file
    markdown.Save(savePath);

เอกสาร

หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับ Aspose.HTML API โปรดไปที่คู่มือ เอกสาร ของเรา บทความเอกสาร Markdown Syntax ให้ข้อมูลเกี่ยวกับองค์ประกอบหลักของ Markdown รายละเอียดและตัวอย่างไวยากรณ์ของ Markdown

ไฟล์ MD ใช้ภาษา Markdown ที่เสนอและพัฒนาโดย John Gruber John Gruber ออกแบบไวยากรณ์การจัดรูปแบบของ Markdown โดยมีเป้าหมายเพื่อให้อ่านง่ายที่สุด Markdown มักใช้เป็นรูปแบบสำหรับเอกสารประกอบและไฟล์ readme เนื่องจากช่วยให้เขียนในรูปแบบที่อ่านง่ายและเขียนง่าย นอกจากนี้ยังสามารถแปลงไฟล์ MD เป็น HTML, PDF, XPS หรือรูปภาพเพื่อใช้ประโยชน์จากรูปแบบอื่นสำหรับงานเฉพาะ

ติดตั้ง Aspose.HTML for .NET

ติดตั้ง Aspose.HTML for .NET จาก NuGet ด้วย .NET CLI:

dotnet add package Aspose.HTML

คุณยังสามารถใช้หน้าต่าง NuGet Package Manager หรือเรียกใช้ Install-Package Aspose.HTML ใน Package Manager Console ได้ ดูรายละเอียดการตั้งค่าใน คู่มือการติดตั้ง หรือขอ ใบอนุญาตชั่วคราว เพื่อประเมิน API โดยไม่มีข้อจำกัดของเวอร์ชันทดลอง

ความต้องการของระบบ

API ของเรารองรับบนแพลตฟอร์มและระบบปฏิบัติการหลักทั้งหมด ก่อนดำเนินการโค้ด โปรดตรวจสอบให้แน่ใจว่าคุณมีข้อกำหนดเบื้องต้นต่อไปนี้ในระบบของคุณ

• Microsoft Windows หรือระบบปฏิบัติการที่เข้ากันได้กับ .NET Framework, .NET Core, Windows Azure, Mono หรือ Xamarin Platforms
• สภาพแวดล้อมการพัฒนาเช่น Microsoft Visual Studio
• Aspose.HTML for .NET DLL ที่อ้างอิงในโครงการของคุณ – ติดตั้งจาก NuGet โดยใช้ปุ่มดาวน์โหลดด้านบน