C# で Markdown ヘッダーを作成する方法

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

Aspose.Html.Toolkit.Markdown.SyntaxAspose.Html.Toolkit.Markdown.Parser 名前空間は、GitHub Flavored Markdown (GFM) 仕様に基づいて完全な Markdown 解析と MD 構文ツリー管理を提供します.


C# で Markdown ヘッダーを追加する方法

C# ライブラリを使用すると、MD ファイルをプログラムで編集して、ドキュメントの構造と内容を変更できます。 C# で Markdown ヘッダー要素を作成する機能があります。テキストノード、テキストノード間のスペース、ヘッダー後の空行など、いくつかのノードからヘッダーを組み立てる必要があるのが特徴です。新しい Markdown ドキュメントをゼロから作成し、それにヘッダーを追加する方法を見てみましょう。

MD ファイルを編集する C# コード

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

    // Get a SyntaxFactory to create new elements
    var mdf = markdown.SyntaxFactory;

    // Create headings of the required level
    var heading1 = mdf.AtxHeading("Heading 1 level text", 1);
    var heading2 = mdf.AtxHeading("Heading 2 level text", 2);
    var heading3 = mdf.AtxHeading("Heading 3 level text", 3);

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

    // Add the headers to the Markdown syntax tree
    markdown.AppendChild(heading1);
    markdown.AppendChild(heading2);
    markdown.AppendChild(heading3);

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

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



C# で Markdown ヘッダーを作成する手順

Markdown ヘッダーを作成する簡単な手順を考えてみましょう。

  1. AtxHeading(string, int) コンストラクターを使用して新しいヘッダーを作成します。 MarkdownSyntaxFactory クラス。テキスト コンテンツと見出しレベルで AtxHeadingSyntaxNode を作成します。
  2. ヘッダーの後の空行に newLineTrivia 要素を作成します。 NewLineTrivia() コンストラクターを使用します。
  3. SyntaxNodeCollection クラスの Add() メソッドを呼び出して、newLineTrivia ノードをヘッダー要素に追加します。
  4. すべてのヘッダー ノードが 1 つの要素に集められたら、それをドキュメントの構文ツリーに追加します。

C# で Markdown ヘッダーを既存の MD ファイルに編集する

次の C# コード例は、既存の MD ドキュメントで Markdown ヘッダーを編集する方法を示しています。

Markdown ヘッダーを追加する C# コード

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

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

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

    // The first element of this document is AtxHeading
    var heading = (AtxHeadingSyntaxNode)syntaxTree.FirstChild;

    // Accumulate the text content from its elements
    var sb = new StringBuilder();

    while (heading.FirstChild != null)
    {
        sb.Append(heading.FirstChild);

        //  Remove accumulated first element from the tree
        heading.RemoveChild(heading.FirstChild);
    }

    // Get a SyntaxFactory to create new elements 
    var syntaxFactory = syntaxTree.SyntaxFactory;

    // Сreate a text node consisting of new and old text and add it as a child element of AtxHeading 
    var textSyntaxNode = syntaxFactory.Text("Added some new text! " + sb);
            
    // Add the new element to the document tree
    heading.AppendChild(textSyntaxNode);

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

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

ドキュメンテーション

Aspose.HTML API の詳細については、 ドキュメント ガイドをご覧ください。 Markdown は、プレーン テキストを書式設定できるシンプルなマークアップ言語です。 Markdown Syntax ドキュメント記事では、主な Markdown 要素、詳細、および Markdown 構文の例に関する情報を提供しています。


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 からインストールします。