C# で Markdown を作成する

C# で Markdown を作成する方法

Markdown は、プレーン テキストを書式設定できるシンプルなマークアップ言語です。 Aspose.HTML for .NET ライブラリは、他のソフトウェアを使用せずに Markdown ファイルを解析および操作できるスタンドアロン ソリューションです。 Markdown ドキュメントをゼロから作成したり、ローカル ファイルから開いたり、新しい要素を挿入したり、既存のノードのコンテンツを削除または編集したりして操作できます。

Aspose.Html.Toolkit.Markdown.Syntax 名前空間には、Markdown 構文ツリー ベースを操作するためのクラスとメソッドが含まれています。 GitHub Flavored Markdown (GFM) 仕様について。

Aspose.Html.Toolkit.Markdown.Parser 名前空間には、完全な Markdown 解析を提供するクラスとメソッドが含まれていますとレンダリング。

Aspose.Html.Toolkit.Markdown.Extensions 名前空間には、Markdown 構文ツリー ベースを操作するためのクラスとメソッドが含まれています。 GFM 仕様の一部ではない仕様について。

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);

C# で Markdown を作成する手順

Markdown をゼロから作成する簡単な手順を見てみましょう。最初の 2 つの手順は、Markdown の作成に必須です。次の手順では、新しい要素を追加してドキュメントを保存します。

1. MarkdownSyntaxTree() コンストラクターを使用して MarkdownSyntaxTree を作成します。
2. SyntaxFactory プロパティを使用して、Markdown 構文ツリーを作成するためのファクトリを取得します。
3. 新しい要素を作成して Markdown ファイルに追加します。
4. 作成した MD ファイルを Save() メソッドで保存します。

C# で MD ファイルを開く方法

次の 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 ファイルは、John Gruber によって提案および開発された Markdown 言語を使用します。 John Gruber は、可能な限り読みやすくすることを目標に、Markdown の書式設定構文を設計しました。マークダウンは、読みやすく、書きやすいスタイルで記述できるため、ドキュメントや readme ファイルの形式としてよく使用されます。さらに、MD ファイルを HTML、PDF、XPS、または画像に変換して、特定のタスクで他の形式を利用することもできます。

よくある質問

Aspose.HTML for .NET API を使ってみる

Aspose.HTML ライブラリ for .NET をシステムにインストールするには、いくつかの方法があります。

1. NuGet パッケージ マネージャー GUI を使用して NuGet パッケージ をインストールします。
2. パッケージ マネージャー コンソールを使用して NuGet パッケージをインストールします。次のコマンド PM> Install-Package Aspose.Html を使用できます。
3. MSI から Aspose.HTML for .NET をインストールします。
   

このライブラリは、HTML5、CSS3、SVG、および HTML Canvas の解析をサポートし、WHATWG DOM 標準に基づくドキュメント オブジェクト モデル (DOM) を構築します。 Aspose.HTML for .NET は完全に C# で記述されており、ASP.NET、WCF、WinForms、.NET Core など、あらゆるタイプの 32 ビットまたは 64 ビットの .NET アプリケーションの構築に使用できます。 .NET 変換サンプル コードを実行する前に、Microsoft Windows または .NET Framework または .NET Standard と互換性のある OS と、Microsoft Visual Studio などの開発環境があることを確認してください。 C# ライブラリのインストールとシステム要件の詳細については、 Aspose.HTML ドキュメント を参照してください。

システム要求

当社の API は、すべての主要なプラットフォームとオペレーティング システムでサポートされています。コードを実行する前に、システムに次の前提条件があることを確認してください。

• Microsoft Windows または .NET Framework、.NET Core、Windows Azure、Mono、または Xamarin プラットフォームと互換性のある OS。
• Microsoft Visual Studio のような開発環境。
• プロジェクトで参照される .NET DLL 用の Aspose.Html – 上記の [ダウンロード] ボタンを使用して NuGet からインストールします。