Як створити вбудований код або кодовий блок Markdown на C#
Бібліотека
Aspose.HTML for .NET
– це окреме рішення, яке дозволяє аналізувати та маніпулювати файлами Markdown без використання іншого програмного забезпечення. Ви можете створити документ Markdown з нуля, відкрити з локального файлу та маніпулювати, вставляючи нові елементи, видаляючи або редагуючи вміст існуючих вузлів.
Використовуйте
Aspose.Html.Toolkit.Markdown.Syntax
і
Aspose.Html.Toolkit.Markdown.Parser
простори імен для забезпечення повного синтаксичного аналізу Markdown і керування синтаксичним деревом MD на основі специфікації GitHub Flavored Markdown (GFM).
Як додати вбудований код Markdown на C#
Використовуючи бібліотеку C#, ви можете програмно редагувати MD-файли – змінювати структуру та вміст документа. Створення вбудованого коду Markdown або блоку коду Markdown на C# має особливість, що елемент CodeSpan або FencedCodeBlock потрібно зібрати з кількох вузлів, таких як текстові вузли, пробіли між текстовими вузлами або порожній рядок після вузла.
Давайте розглянемо створення документа Markdown з нуля та додавання до нього вбудованого коду.
Код C# для додавання вбудованого коду до файлу MD
// Create the MarkdownSyntaxTree
var markdown = new MarkdownSyntaxTree(new Configuration());
// Use the SyntaxFactory property to get the factory for creating the Markdown syntax tree
var mdf = markdown.SyntaxFactory;
// Create an empty codeSpan node
var codeSpan = mdf.CodeSpan();
// Create text content for the codeSpan
codeSpan.AppendChild(mdf.Text("Source code text"));
// Add codeSpan to MD document
markdown.AppendChild(codeSpan);
// Add a space after the code node through a special WhiteSpace node
markdown.AppendChild(mdf.Whitespace());
// Prepare a path for MD file saving
string savePath = Path.Combine(OutputDir, "markdown-code.md");
// Save MD file
markdown.Save(savePath);
Кроки для створення коду в Markdown на C#
Нагадуємо, що вбудований код потрібно зібрати з вузлів компонента. Розглянемо прості кроки для створення вбудованого коду Markdown:
- Створіть новий порожній вузол CodeSpan за допомогою конструктора CodeSpan() у SyntaxFactory.
- Використовуйте конструктор Text(), щоб створити текстові вузли для CodeSpan.
- Викличте метод AppendChild() класу MarkdownSyntaxNode, щоб додати текстові вузли в елемент CodeSpan.
- Додайте створений блок коду до синтаксичного дерева документа за допомогою методу AppendChild().
- Використовуйте конструктор Whitespace(), щоб створити пробіл після вбудованого коду.
Додайте блок коду до файлу MD на C#
У наступному прикладі коду C# показано, як додати блок коду до документа MD:
Код C# для додавання блоку коду Markdown
// Create the MarkdownSyntaxTree
var markdown = new MarkdownSyntaxTree(new Configuration());
// Create a Markdown syntax factory
var mdf = markdown.SyntaxFactory;
// Create a start token and an end token that will frame a code block
var startToken = mdf.Token(SourceText.From("```\r\n"));
var endToken = mdf.Token(SourceText.From("\r\n```"));
// Create a fenced code element
var fencedCodeSpan = mdf.FencedCodeBlock(startToken, null, endToken);
// Create text content for the fenced code element
fencedCodeSpan.AppendChild(mdf.Text("Source code text"));
//Add the fenced code element to MD file
markdown.AppendChild(fencedCodeSpan);
// Prepare a path for MD file saving
string savePath = Path.Combine(OutputDir, "markdown-code-block.md");
// Save MD file
markdown.Save(savePath);
Документація
Щоб дізнатися більше про API Aspose.HTML, відвідайте наш посібник із
документації.
Markdown – це проста мова розмітки, яка дозволяє форматувати звичайний текст. Стаття документації
Markdown Syntax
містить інформацію про основні елементи Markdown, деталі та приклади синтаксису Markdown.
FAQ
Бібліотека Aspose.HTML for .NET – це окреме рішення для роботи з документами Markdown, яке не залежить від іншого програмного забезпечення. Установіть нашу бібліотеку C#, додайте посилання на бібліотеку до свого проекту C# та програмно працюйте з документами Markdown.
Markdown дуже популярний серед авторів, розробників і творців контенту завдяки своїй універсальності. Його переваги включають легкий у вивченні та використанні синтаксис, портативність, гнучкість, читабельність і зручність використання. Markdown простий та інтуїтивно зрозумілий і може бути конвертований у HTML, PDF або інші формати.
Ви можете працювати з документами Markdown у будь-якій операційній системі, незалежно від того, використовуєте ви Windows, Mac OS, Linux, Android або iOS.
Ми підтримуємо кілька форматів файлів, які ви можете створювати, відкривати, аналізувати, редагувати, зберігати або конвертувати на C#. Це формати HTML, XHTML, MHTML і Markdown.
Початок роботи з Aspose.HTML for .NET API
Ви можете скористатися кількома способами інсталяції бібліотеки Aspose.HTML for .NET у вашій системі:
- Установіть пакет NuGet за допомогою графічного інтерфейсу користувача NuGet Package Manager.
- Встановіть пакет NuGet за допомогою консолі диспетчера пакетів. Ви можете використати таку команду
PM> Install-Package Aspose.Html
. - Установіть Aspose.HTML for .NET через MSI.
Ця бібліотека підтримує аналіз HTML5, CSS3, SVG і HTML Canvas для створення об’єктної моделі документа (DOM) на основі стандарту WHATWG DOM. Aspose.HTML for .NET повністю написаний на C# і може використовуватися для створення будь-якого типу 32-розрядних або 64-розрядних додатків .NET, включаючи ASP.NET, WCF, WinForms і .NET Core. Перш ніж запустити приклад коду перетворення .NET, переконайтеся, що у вас ОС, як-от Microsoft Windows, або сумісна з .NET Framework або .NET Standard, і середовище розробки, як-от Microsoft Visual Studio. Додаткову інформацію про встановлення бібліотеки C# та системні вимоги ви знайдете у документації Aspose.HTML.
Системні вимоги
Наші API підтримуються на всіх основних платформах і операційних системах. Перш ніж виконувати код, переконайтеся, що у вашій системі є такі передумови.
- Microsoft Windows або сумісна ОС з платформами .NET Framework, .NET Core, Windows Azure, Mono або Xamarin.
- Середовище розробки, наприклад Microsoft Visual Studio.
- Aspose.HTML for .NET DLL, на який посилається ваш проект – Встановіть із NuGet за допомогою кнопки «Download» вище.