MARKDOWN Archives - icodebroker

[C#/COMMON/MARKDIG/.NET8] Markdown 클래스 : Parse 정적 메소드를 사용해 마크다운 문자열 파싱하기

■ Markdown 클래스의 Parse 정적 메소드를 사용해 마크다운 문자열을 파싱하는 방법을 보여준다. ▶ Program.cs


using Markdig;
using Markdig.Syntax;

namespace TestProject;

/// <summary>
/// 프로그램
/// </summary>
class Program
{
    //////////////////////////////////////////////////////////////////////////////////////////////////// Method
    ////////////////////////////////////////////////////////////////////////////////////////// Static
    //////////////////////////////////////////////////////////////////////////////// Private

    #region 프로그램 시작하기 - Main()

    /// <summary>
    /// 프로그램 시작하기
    /// </summary>
    static void Main()
    {
        #region 마크다운 문자열을 설정한다.

        string markdownString = @"
# 제목

이것은 **Markdown** 문서입니다.

- 목록 항목 1
- 목록 항목 2
- 목록 항목 3

```csharp
// 코드 블록 예제
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");
```

1. 순서가 있는 항목
1. 순서가 있는 항목
    1. 순서가 없는 항목
    1. 순서가 없는 항목
1. 순서가 있는 항목
1. 순서가 있는 항목

- 순서가 없는 항목
- 순서가 없는 항목
    - 순서가 없는 항목
    - 순서가 없는 항목

| 값 | 의미 | 기본값 |
|---|:---:|---:|
| `static` | 유형(기준) 없음 / 배치 불가능 | `static` |
| `relative` | 요소 자신을 기준으로 배치 |  |
| `absolute` | 위치 상 부모(조상)요소를 기준으로 배치 |  |
| `fixed` | 브라우저 창을 기준으로 배치 |  |
| `sticky` | 스크롤 영역 기준으로 배치 |  |

> 인용문을 작성하세요!
>> 중첩된 인용문(nested blockquote)을 만들 수 있습니다.
>>> 중중첩 인용문 1
>>> 중중첩 인용문 2
>>> 중중첩 인용문 3

| 값 | 의미 |
|---|---|
| 버티컬바 출력 | \| |
| 인라인 코드 강조 | `\|` |

> 인용문 - 남의 말이나 글에서 직접 또는 간접으로 따온 문장.
> _(네이버 국어 사전)_

BREAK!

![Prunus](http://www.gstatic.com/webp/gallery/4.jpg)

1. 순서가 있는 항목
1. 순서가 있는 항목
    1. 순서가 없는 항목
    1. 순서가 없는 항목
1. 순서가 있는 항목
1. 순서가 있는 항목

[샘플 PDF 다운로드](https://drive.google.com/file/d/1P-2-Rui-5lX5v2vIUDtMp_NRr1Fmp3--/view?usp=drive_link)
";

    #endregion

        MarkdownPipeline markdownPipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build();

        MarkdownDocument markdownDocument = Markdown.Parse(markdownString, markdownPipeline);

        foreach(Block block in markdownDocument)
        {
            MarkdownHelper.EnumerateBlock(block, 0);
        }
    }

    #endregion
}

100

101

102

103

104

105

106

107

108

109

110

111

112

using Markdig;

using Markdig.Syntax;

namespace TestProject;

/// <summary>

/// 프로그램

/// </summary>

class Program

{

//////////////////////////////////////////////////////////////////////////////////////////////////// Method

////////////////////////////////////////////////////////////////////////////////////////// Static

//////////////////////////////////////////////////////////////////////////////// Private

#region 프로그램 시작하기 - Main()

/// <summary>

/// 프로그램 시작하기

/// </summary>

static void Main()

{

#region 마크다운 문자열을 설정한다.

string markdownString = @"

# 제목

이것은 **Markdown** 문서입니다.

- 목록 항목 1

- 목록 항목 2

- 목록 항목 3

```csharp

// 코드 블록 예제

Console.WriteLine(""Hello, World!""); Console.WriteLine(""Hello, World!"");

```

1. 순서가 있는 항목

1. 순서가 없는 항목

1. 순서가 있는 항목

- 순서가 없는 항목

| 값 | 의미 | 기본값 |

|---|:---:|---:|

| `static` | 유형(기준) 없음 / 배치 불가능 | `static` |

| `relative` | 요소 자신을 기준으로 배치 | |

| `absolute` | 위치 상 부모(조상)요소를 기준으로 배치 | |

| `fixed` | 브라우저 창을 기준으로 배치 | |

| `sticky` | 스크롤 영역 기준으로 배치 | |

> 인용문을 작성하세요!

>> 중첩된 인용문(nested blockquote)을 만들 수 있습니다.

>>> 중중첩 인용문 1

>>> 중중첩 인용문 2

>>> 중중첩 인용문 3

| 값 | 의미 |

|---|---|

| 버티컬바 출력 | \| |

| 인라인 코드 강조 | `\|` |

> 인용문 - 남의 말이나 글에서 직접 또는 간접으로 따온 문장.

> _(네이버 국어 사전)_

BREAK!

![Prunus](http://www.gstatic.com/webp/gallery/4.jpg)

1. 순서가 있는 항목

1. 순서가 없는 항목

1. 순서가 있는 항목

[샘플 PDF 다운로드](https://drive.google.com/file/d/1P-2-Rui-5lX5v2vIUDtMp_NRr1Fmp3--/view?usp=drive_link)

#endregion

MarkdownPipeline markdownPipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build();

MarkdownDocument markdownDocument = Markdown.Parse(markdownString, markdownPipeline);

foreach(Block block in markdownDocument)

{

MarkdownHelper.EnumerateBlock(block, 0);

}

#endregion

}

▶ MarkdownHelper.cs


using Markdig.Extensions.Tables;
using Markdig.Syntax.Inlines;
using Markdig.Syntax;

public static class MarkdownHelper
{
    //////////////////////////////////////////////////////////////////////////////////////////////////// Method
    ////////////////////////////////////////////////////////////////////////////////////////// Static
    //////////////////////////////////////////////////////////////////////////////// Public

    #region 블럭 나열하기 - EnumerateBlock(block, level)

    /// <summary>
    /// 블럭 나열하기
    /// </summary>
    /// <param name="block">블럭</param>
    /// <param name="level">레벨</param>
    public static void EnumerateBlock(Block block, int level)
    {
        if(block is Table table)
        {
            WriteElementType(block, level, false);

            Console.Write(" : [");

            TableRow firstTableRow = table[0] as TableRow;

            for(int i = 0; i < firstTableRow.Count; i++)
            {
                TableColumnDefinition tableColumnDefinition = table.ColumnDefinitions[i];

                if(i > 0)
                {
                    Console.Write(",");
                }

                if(tableColumnDefinition.Alignment.HasValue)
                {
                    Console.Write($"{tableColumnDefinition.Alignment.Value}");
                }
                else
                {
                    Console.Write($"{TableColumnAlign.Left}");
                }
            }

            Console.WriteLine("]");

            foreach(Block childBlock in table)
            {
                if(childBlock is TableRow tableRow)
                {
                    EnumerateTableRow(tableRow, level + 1);
                }
                else
                {
                    EnumerateBlock(childBlock, level + 1);
                }
            }
        }
        else
        {
            if(block is LeafBlock)
            {
                if(block is ParagraphBlock paragraphBlock)
                {
                    WriteElementType(block, level, true);

                    EnumerateInline(paragraphBlock.Inline, level + 1);
                }
                else if(block is HeadingBlock headingBlock)
                {
                    WriteElementType(block, level, false);

                    Console.WriteLine($" : {headingBlock.Level}");

                    EnumerateInline(headingBlock.Inline, level + 1);
                }
                else if(block is FencedCodeBlock fencedCodeBlock)
                {
                    WriteElementType(block, level, false);

                    Console.WriteLine($" : {fencedCodeBlock.Info}");
                    Console.WriteLine("----------------------------------------------------------------------------------------------------");

                    foreach(object line in fencedCodeBlock.Lines)
                    {
                        Console.WriteLine(line.ToString());
                    }

                    Console.WriteLine("----------------------------------------------------------------------------------------------------");
                }
                else
                {
                    WriteElementType(block, level, true);

                    return;
                }
            }
            else if(block is ContainerBlock containerBlock)
            {
                WriteElementType(block, level, true);

                foreach(Block childBlock in containerBlock)
                {
                    EnumerateBlock(childBlock, level + 1);
                }
            }
        }
    }

    #endregion

    //////////////////////////////////////////////////////////////////////////////// Private

    #region 엘리먼트 타입 쓰기 - WriteElementType(inline, level, newLine)

    /// <summary>
    /// 엘리먼트 타입 쓰기
    /// </summary>
    /// <param name="inline">인라인</param>
    /// <param name="level">레벨</param>
    /// <param name="newLine">개행 여부</param>
    private static void WriteElementType(Inline inline, int level, bool newLine = true)
    {
        int count = level * 4;

        string padding = count > 0 ? new string(' ', count) : string.Empty;

        string elementType = $"{padding}{inline.GetType().Name}";

        if(newLine)
        {
            Console.WriteLine(elementType);
        }
        else
        {
            Console.Write(elementType);
        }
    }

        #endregion
    #region 인라인 열거하기 - EnumerateInline(inline, level)

    /// <summary>
    /// 인라인 열거하기
    /// </summary>
    /// <param name="inline">인라인</param>
    /// <param name="level">레벨</param>
    private static void EnumerateInline(Inline inline, int level)
    {
        if(inline is ContainerInline containerInline)
        {
            if(containerInline is LinkInline linkInline)
            {
                WriteElementType(inline, level, false);

                string isImage = linkInline.IsImage ? "(이미지)" : "(링크)";

                Console.WriteLine($" : {isImage} {linkInline.Url}");

                foreach(Inline childInline in containerInline)
                {
                    EnumerateInline(childInline, level + 1);
                }
            }
            else
            {
                WriteElementType(inline, level, true);

                foreach(Inline childInline in containerInline)
                {
                    EnumerateInline(childInline, level + 1);
                }
            }
        }
        else if(inline is LeafInline leafInline)
        {
            if(inline is LiteralInline literalInline)
            {
                WriteElementType(inline, level, false);

                Console.WriteLine(" : " + literalInline.Content);
            }
            else if(inline is CodeInline codeInline)
            {
                WriteElementType(inline, level, false);

                Console.WriteLine(" : " + codeInline.Content);
            }
            else
            {
                WriteElementType(inline, level, true);
            }

            return;
        }
    }

    #endregion
    #region 엘리먼트 타입 쓰기 - WriteElementType(block, level, newLine)

    /// <summary>
    /// 엘리먼트 타입 쓰기
    /// </summary>
    /// <param name="block">블럭</param>
    /// <param name="level">레벨</param>
    /// <param name="newLine">신규 행 여부</param>
    private static void WriteElementType(Block block, int level, bool newLine = true)
    {
        int count = level * 4;

        string padding = count > 0 ? new string(' ', count) : string.Empty;

        string elementType = $"{padding}{block.GetType().Name}";

        if(newLine)
        {
            Console.WriteLine(elementType);
        }
        else
        {
            Console.Write(elementType);
        }
    }

    #endregion
    #region 테이블 셀 열거하기 - EnumerateTableCell(tableCell, level)

    /// <summary>
    /// 테이블 셀 열거하기
    /// </summary>
    /// <param name="tableCell">테이블 셀</param>
    /// <param name="level">레벨</param>
    private static void EnumerateTableCell(TableCell tableCell, int level)
    {
        WriteElementType(tableCell, level, true);

        foreach(Block childBlock in tableCell)
        {
            EnumerateBlock(childBlock, level + 1);
        }
    }

    #endregion
    #region 테이블 행 열거하기 - EnumerateTableRow(tableRow, level)

    /// <summary>
    /// 테이블 행 열거하기
    /// </summary>
    /// <param name="tableRow">테이블 행</param>
    /// <param name="level">레벨</param>
    private static void EnumerateTableRow(TableRow tableRow, int level)
    {
        WriteElementType(tableRow, level, true);

        foreach(Block childBlock in tableRow)
        {
            if(childBlock is TableCell tableCell)
            {
                EnumerateTableCell(tableCell, level + 1);
            }
            else
            {
                EnumerateBlock(childBlock, level + 1);
            }
        }
    }

    #endregion
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

using Markdig.Extensions.Tables;

using Markdig.Syntax.Inlines;

using Markdig.Syntax;

public static class MarkdownHelper

{

//////////////////////////////////////////////////////////////////////////////////////////////////// Method

////////////////////////////////////////////////////////////////////////////////////////// Static

//////////////////////////////////////////////////////////////////////////////// Public

#region 블럭 나열하기 - EnumerateBlock(block, level)

/// <summary>

/// 블럭 나열하기

/// </summary>

/// <param name="block">블럭</param>

/// <param name="level">레벨</param>

public static void EnumerateBlock(Block block, int level)

{

if(block is Table table)

{

WriteElementType(block, level, false);

Console.Write(" : [");

TableRow firstTableRow = table[0] as TableRow;

for(int i = 0; i < firstTableRow.Count; i++)

{

TableColumnDefinition tableColumnDefinition = table.ColumnDefinitions[i];

if(i > 0)

{

Console.Write(",");

}

if(tableColumnDefinition.Alignment.HasValue)

{

Console.Write($"{tableColumnDefinition.Alignment.Value}");

}

else

{

Console.Write($"{TableColumnAlign.Left}");

}

Console.WriteLine("]");

foreach(Block childBlock in table)

{

if(childBlock is TableRow tableRow)

{

EnumerateTableRow(tableRow, level + 1);

}

else

{

EnumerateBlock(childBlock, level + 1);

}

else

{

if(block is LeafBlock)

{

if(block is ParagraphBlock paragraphBlock)

{

WriteElementType(block, level, true);

EnumerateInline(paragraphBlock.Inline, level + 1);

}

else if(block is HeadingBlock headingBlock)

{

WriteElementType(block, level, false);

Console.WriteLine($" : {headingBlock.Level}");

EnumerateInline(headingBlock.Inline, level + 1);

}

else if(block is FencedCodeBlock fencedCodeBlock)

{

WriteElementType(block, level, false);

Console.WriteLine($" : {fencedCodeBlock.Info}");

Console.WriteLine("----------------------------------------------------------------------------------------------------");

foreach(object line in fencedCodeBlock.Lines)

{

Console.WriteLine(line.ToString());

}

Console.WriteLine("----------------------------------------------------------------------------------------------------");

}

else

{

WriteElementType(block, level, true);

return;

}

else if(block is ContainerBlock containerBlock)

{

WriteElementType(block, level, true);

foreach(Block childBlock in containerBlock)

{

EnumerateBlock(childBlock, level + 1);

}

#endregion

//////////////////////////////////////////////////////////////////////////////// Private

#region 엘리먼트 타입 쓰기 - WriteElementType(inline, level, newLine)

/// <summary>

/// 엘리먼트 타입 쓰기

/// </summary>

/// <param name="inline">인라인</param>

/// <param name="level">레벨</param>

/// <param name="newLine">개행 여부</param>

private static void WriteElementType(Inline inline, int level, bool newLine = true)

{

int count = level * 4;

string padding = count > 0 ? new string(' ', count) : string.Empty;

string elementType = $"{padding}{inline.GetType().Name}";

if(newLine)

{

Console.WriteLine(elementType);

}

else

{

Console.Write(elementType);

}

#endregion

#region 인라인 열거하기 - EnumerateInline(inline, level)

/// <summary>

/// 인라인 열거하기

/// </summary>

/// <param name="inline">인라인</param>

/// <param name="level">레벨</param>

private static void EnumerateInline(Inline inline, int level)

{

if(inline is ContainerInline containerInline)

{

if(containerInline is LinkInline linkInline)

{

WriteElementType(inline, level, false);

string isImage = linkInline.IsImage ? "(이미지)" : "(링크)";

Console.WriteLine($" : {isImage} {linkInline.Url}");

foreach(Inline childInline in containerInline)

{

EnumerateInline(childInline, level + 1);

}

else

{

WriteElementType(inline, level, true);

foreach(Inline childInline in containerInline)

{

EnumerateInline(childInline, level + 1);

}

else if(inline is LeafInline leafInline)

{

if(inline is LiteralInline literalInline)

{

WriteElementType(inline, level, false);

Console.WriteLine(" : " + literalInline.Content);

}

else if(inline is CodeInline codeInline)

{

WriteElementType(inline, level, false);

Console.WriteLine(" : " + codeInline.Content);

}

else

{

WriteElementType(inline, level, true);

}

return;

}

#endregion

#region 엘리먼트 타입 쓰기 - WriteElementType(block, level, newLine)

/// <summary>

/// 엘리먼트 타입 쓰기

/// </summary>

/// <param name="block">블럭</param>

/// <param name="level">레벨</param>

/// <param name="newLine">신규 행 여부</param>

private static void WriteElementType(Block block, int level, bool newLine = true)

{

int count = level * 4;

string padding = count > 0 ? new string(' ', count) : string.Empty;

string elementType = $"{padding}{block.GetType().Name}";

if(newLine)

{

Console.WriteLine(elementType);

}

else

{

Console.Write(elementType);

}

#endregion

#region 테이블 셀 열거하기 - EnumerateTableCell(tableCell, level)

/// <summary>

/// 테이블 셀 열거하기

/// </summary>

/// <param name="tableCell">테이블 셀</param>

/// <param name="level">레벨</param>

private static void EnumerateTableCell(TableCell tableCell, int level)

{

WriteElementType(tableCell, level, true);

foreach(Block childBlock in tableCell)

{

EnumerateBlock(childBlock, level + 1);

}

#endregion

#region 테이블 행 열거하기 - EnumerateTableRow(tableRow, level)

/// <summary>

/// 테이블 행 열거하기

/// </summary>

/// <param name="tableRow">테이블 행</param>

/// <param name="level">레벨</param>

private static void EnumerateTableRow(TableRow tableRow, int level)

{

WriteElementType(tableRow, level, true);

foreach(Block childBlock in tableRow)

{

if(childBlock is TableCell tableCell)

{

EnumerateTableCell(tableCell, level + 1);

}

else

{

EnumerateBlock(childBlock, level + 1);

}

#endregion

}

TestProject.zip

[C#/COMMON/MARKDIG/.NET8] MarkdownExtensions 클래스 : UseAdvancedExtensions 확장 메소드를 사용해 고급 확장 기능 활성화하기

■ MarkdownExtensions 클래스의 UseAdvancedExtensions 확장 메소드를 사용해 고급 확장 기능을 활성화하는 방법을 보여준다. ▶ 예제 코드 (C#)


using Markdig;

MarkdownPipelineBuilder markdownPipelineBuilder = new MarkdownPipelineBuilder().UseAdvancedExtensions();

using Markdig;

MarkdownPipelineBuilder markdownPipelineBuilder = new MarkdownPipelineBuilder().UseAdvancedExtensions();

[C#/COMMON/MARKDIG/.NET8] MarkdownPipelineBuilder 클래스 : Build 메소드를 사용해 MarkdownPipeline 객체 만들기

■ MarkdownPipelineBuilder 클래스의 Build 메소드를 사용해 MarkdownPipeline 객체를 만드는 방법을 보여준다. ▶ 예제 코드 (C#)


using Markdig;

MarkdownPipeline markdownPipeline = new MarkdownPipelineBuilder()
                                        .UseAdvancedExtensions()
                                        .Build();

using Markdig;

MarkdownPipeline markdownPipeline = new MarkdownPipelineBuilder()

.UseAdvancedExtensions()

.Build();

[C#/COMMON/MARKDIG/.NET8] MarkdownPipelineBuilder 클래스 : 마크다운 파이프라인 빌더 객체 만들기

■ MarkdownPipelineBuilder 클래스를 사용해 마크다운 파이프라인 빌더 객체를 만드는 방법을 보여준다. ▶ 예제 코드 (C#)


using Markdig;

MarkdownPipelineBuilder markdownPipelineBuilder = new MarkdownPipelineBuilder();

using Markdig;

MarkdownPipelineBuilder markdownPipelineBuilder = new MarkdownPipelineBuilder();

[C#/COMMON/MARKDIG/.NET8] HeadingBlock 클래스 : Inline 속성을 사용해 텍스트 구하기

■ HeadingBlock 클래스의 Inline 속성을 사용해 텍스트를 구하는 방법을 보여준다. ▶ 예제 코드 (C#)


string markdownString = @"
이것은 **Markdown** 문서입니다.

- 목록 항목 1
- 목록 항목 2
- 목록 항목 3

# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6
";

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

foreach(HeadingBlock headingBlock in markdownDocument.Descendants<HeadingBlock>())
{
    int    level            = headingBlock.Level;
    string headingBlockText = GetHeadingBlockText(headingBlock);

    Console.WriteLine($"레벨 {headingBlock.Level} : {headingBlockText}");
}

#region 헤딩 블럭 텍스트 구하기 - GetHeadingBlockText(headingBlock)

/// <summary>
/// 헤딩 블럭 텍스트 구하기
/// </summary>
/// <param name="headingBlock">헤딩 블럭</param>
/// <returns>헤딩 블럭 텍스트</returns>
public string GetHeadingBlockText(HeadingBlock headingBlock)
{
    StringWriter writer   = new StringWriter();
    HtmlRenderer renderer = new HtmlRenderer(writer);

    foreach(Inline inline in headingBlock.Inline)
    {
        renderer.Write(inline);
    }

    return writer.ToString();
}

#endregion

string markdownString = @"

이것은 **Markdown** 문서입니다.

- 목록 항목 1

- 목록 항목 2

- 목록 항목 3

# 제목 1

## 제목 2

### 제목 3

#### 제목 4

##### 제목 5

###### 제목 6

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

foreach(HeadingBlock headingBlock in markdownDocument.Descendants<HeadingBlock>())

{

int level = headingBlock.Level;

string headingBlockText = GetHeadingBlockText(headingBlock);

Console.WriteLine($"레벨 {headingBlock.Level} : {headingBlockText}");

}

#region 헤딩 블럭 텍스트 구하기 - GetHeadingBlockText(headingBlock)

/// <summary>

/// 헤딩 블럭 텍스트 구하기

/// </summary>

/// <param name="headingBlock">헤딩 블럭</param>

/// <returns>헤딩 블럭 텍스트</returns>

public string GetHeadingBlockText(HeadingBlock headingBlock)

{

StringWriter writer = new StringWriter();

HtmlRenderer renderer = new HtmlRenderer(writer);

foreach(Inline inline in headingBlock.Inline)

{

renderer.Write(inline);

}

return writer.ToString();

}

#endregion

[C#/COMMON/MARKDIG/.NET8] Inline 클래스 및 파생 클래스

■ Inline 클래스 및 파생 클래스를 보여준다. ▶ 클래스 상속


MarkdownObject (IMarkdownObject)
    Inline (IInline)
        ContainerInline (IEnumerable<Inline>)
            EmphasisInline
            LinkInline
        FootnoteLink
        LeafInline
            AutolinkInline
            CodeInline
            HtmlEntityInline
            HtmlInline
            LineBreakInline
            LiteralInline
                EmojiInline
                AbbreviationInline

MarkdownObject (IMarkdownObject)

Inline (IInline)

ContainerInline (IEnumerable<Inline>)

EmphasisInline

LinkInline

FootnoteLink

LeafInline

AutolinkInline

CodeInline

HtmlEntityInline

HtmlInline

LineBreakInline

LiteralInline

EmojiInline

AbbreviationInline

※ AbbreviationInline 클래스 : Markdig.Extensions.Abbreviations 네임스페이스 ※ EmojiInline 클래스 : Markdig.Extensions.Emoji

[C#/COMMON/MARKDIG/.NET8] MarkdownDocument 클래스 : Descendants 메소드를 사용해 해당 타입 IEnumerable 객체 구하기

■ MarkdownDocument 클래스의 Descendants<T> 메소드를 사용해 해당 타입의 IEnumerable<T> 객체를 구하는 방법을 보여준다. ▶ 예제 코드 (C#)


using System;

using Markdig;
using Markdig.Syntax;

string markdownString = @"
이것은 **Markdown** 문서입니다.

- 목록 항목 1
- 목록 항목 2
- 목록 항목 3

# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6
";

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

foreach(HeadingBlock headingBlock in markdownDocument.Descendants<HeadingBlock>())
{
    Console.WriteLine($"Level {headingBlock.Level}");
}

using System;

using Markdig;

using Markdig.Syntax;

string markdownString = @"

이것은 **Markdown** 문서입니다.

- 목록 항목 1

- 목록 항목 2

- 목록 항목 3

# 제목 1

## 제목 2

### 제목 3

#### 제목 4

##### 제목 5

###### 제목 6

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

foreach(HeadingBlock headingBlock in markdownDocument.Descendants<HeadingBlock>())

{

Console.WriteLine($"Level {headingBlock.Level}");

}

[C#/COMMON/MARKDIG/.NET8] MarkdownDocument 클래스 : Block 객체 계층적으로 나열하기

■ MarkdownDocument 클래스를 사용해 Block 객체를 계층적으로 나열하는 방법을 보여준다. ▶ 예제 코드 (C#)


using System;
using Markdig;
using Markdig.Syntax;

string markdownString = @"
# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6

이것은 **Markdown** 문서입니다.

- 목록 항목 1
- 목록 항목 2
- 목록 항목 3
";

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

foreach(Block block in markdownDocument)
{
    EnumerateBlock(block);
}

#region 블럭 나열하기 - EnumerateBlock(block, level)

/// <summary>
/// 블럭 나열하기
/// </summary>
/// <param name="block">블럭</param>
/// <param name="level">레벨</param>
public void EnumerateBlock(Block block, int level = 0)
{
    string padding = level == 0 ? string.Empty : "    ".PadLeft((level - 1) * 4);

    Console.WriteLine($"{padding}{block.GetType().Name}");

    if(block is LeafBlock)
    {
        return;
    }
    else if(block is ContainerBlock containerBlock)
    {
        foreach(Block childBlock in containerBlock)
        {
            EnumerateBlock(childBlock, level + 1);
        }
    }
}

#endregion

using System;

using Markdig;

using Markdig.Syntax;

string markdownString = @"

# 제목 1

## 제목 2

### 제목 3

#### 제목 4

##### 제목 5

###### 제목 6

이것은 **Markdown** 문서입니다.

- 목록 항목 1

- 목록 항목 2

- 목록 항목 3

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

foreach(Block block in markdownDocument)

{

EnumerateBlock(block);

}

#region 블럭 나열하기 - EnumerateBlock(block, level)

/// <summary>

/// 블럭 나열하기

/// </summary>

/// <param name="block">블럭</param>

/// <param name="level">레벨</param>

public void EnumerateBlock(Block block, int level = 0)

{

string padding = level == 0 ? string.Empty : " ".PadLeft((level - 1) * 4);

Console.WriteLine($"{padding}{block.GetType().Name}");

if(block is LeafBlock)

{

return;

}

else if(block is ContainerBlock containerBlock)

{

foreach(Block childBlock in containerBlock)

{

EnumerateBlock(childBlock, level + 1);

}

#endregion

[C#/COMMON/MARKDIG/.NET8] Block 클래스 및 파생 클래스

■ Block 클래스 및 파생 클래스를 보여준다. ▶ 클래스 상속


MarkdownObject (IMarkdownObject)
    Block (IBlock)
        ContainerBlock (IList<Block>, IReadOnlyList<Block>)
            ListBlock
            ListItemBlock
            QuoteBlock
            Table
            TableRow
            TableCell
        LeafBlock
            CodeBlock
                FencedCodeBlock (IFencedBlock)
                    MathBlock
                YamlFrontMatterBlock
            EmptyBlock
            HeadingBlock
            HtmlBlock
            LinkReferenceDefinition
            ParagraphBlock
            ThematicBreakBlock

MarkdownObject (IMarkdownObject)

Block (IBlock)

ContainerBlock (IList<Block>, IReadOnlyList<Block>)

ListBlock

ListItemBlock

QuoteBlock

Table

TableRow

TableCell

LeafBlock

CodeBlock

FencedCodeBlock (IFencedBlock)

MathBlock

YamlFrontMatterBlock

EmptyBlock

HeadingBlock

HtmlBlock

LinkReferenceDefinition

ParagraphBlock

ThematicBreakBlock

※ MathBlock 클래스 : Markdig.Extensions.Mathematics 네임스페이스 ※ Table 클래스 : Markdig.Extensions.Tables

[C#/COMMON/MARKDIG/.NET8] Markdown 클래스 : Parse 정적 메소드를 사용해 마크다운 문자열을 파싱한 MarkdownDocument 객체 구하기

■ Markdown 클래스의 Parse 정적 메소드를 사용해 마크다운 문자열을 파싱한 MarkdownDocument 객체를 구하는 방법을 보여준다. ▶ 예제 코드 (C#)


string markdownString = @"
# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6
";

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

string markdownString = @"

# 제목 1

## 제목 2

### 제목 3

#### 제목 4

##### 제목 5

###### 제목 6

MarkdownDocument markdownDocument = Markdown.Parse(markdownString);

[C#/COMMON/MARKDIG/.NET8] Markdig 누겟 설치하기

■ Markdig 누겟을 설치하는 방법을 보여준다. 1. Visual Studio를 실행한다. 2. [도구] / [NuGet 패키지 관리자] / [패키지 관리자 콘솔] 메뉴를 실행한다.

[PYTHON/LANGCHAIN] MarkdownHeaderTextSplitter 클래스 : 생성한 문서 리스트를 RecursiveCharacterTextSplitter 객체를 사용해 청크 크기 제한하기

■ MarkdownHeaderTextSplitter 클래스에서 생성한 문서 리스트를 RecursiveCharacterTextSplitter 객체를 사용해 청크 크기를 제한하는 방법을 보여준다. ▶ main.py


from langchain_text_splitters import MarkdownHeaderTextSplitter
from langchain_text_splitters import RecursiveCharacterTextSplitter

codeString = "# Foo\n\n    ## Bar\n\nHi this is Jim\n\nHi this is Joe\n\n ### Boo \n\n Hi this is Lance \n\n ## Baz\n\n Hi this is Molly"

headerListToSplitOn = [
    ("#"  , "Header 1"),
    ("##" , "Header 2"),
    ("###", "Header 3")
]

markdownHeaderTextSplitter = MarkdownHeaderTextSplitter(headerListToSplitOn, return_each_line = True)

documentList1 = markdownHeaderTextSplitter.split_text(codeString)

recursiveCharacterTextSplitter = RecursiveCharacterTextSplitter(chunk_size = 260, chunk_overlap = 30)

documentList2 = recursiveCharacterTextSplitter.split_documents(documentList1)

for document in documentList2:
    print(document)

"""
page_content='Hi this is Jim' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}
page_content='Hi this is Joe' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}
page_content='Hi this is Lance' metadata={'Header 1': 'Foo', 'Header 2': 'Bar', 'Header 3': 'Boo'}
page_content='Hi this is Molly' metadata={'Header 1': 'Foo', 'Header 2': 'Baz'}
"""

from langchain_text_splitters import MarkdownHeaderTextSplitter

from langchain_text_splitters import RecursiveCharacterTextSplitter

codeString = "# Foo\n\n ## Bar\n\nHi this is Jim\n\nHi this is Joe\n\n ### Boo \n\n Hi this is Lance \n\n ## Baz\n\n Hi this is Molly"

headerListToSplitOn = [

("#" , "Header 1"),

("##" , "Header 2"),

("###", "Header 3")

]

markdownHeaderTextSplitter = MarkdownHeaderTextSplitter(headerListToSplitOn, return_each_line = True)

documentList1 = markdownHeaderTextSplitter.split_text(codeString)

recursiveCharacterTextSplitter = RecursiveCharacterTextSplitter(chunk_size = 260, chunk_overlap = 30)

documentList2 = recursiveCharacterTextSplitter.split_documents(documentList1)

for document in documentList2:

print(document)

"""

page_content='Hi this is Jim' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}

page_content='Hi this is Joe' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}

page_content='Hi this is Lance' metadata={'Header 1': 'Foo', 'Header 2': 'Bar', 'Header 3': 'Boo'}

page_content='Hi this is Molly' metadata={'Header 1': 'Foo', 'Header 2': 'Baz'}

"""

▶ requirements.txt


annotated-types==0.7.0
certifi==2024.6.2
charset-normalizer==3.3.2
idna==3.7
jsonpatch==1.33
jsonpointer==3.0.0
langchain-core==0.2.10
langchain-text-splitters==0.2.2
langsmith==0.1.82
orjson==3.10.5
packaging==24.1
pydantic==2.7.4
pydantic_core==2.18.4
PyYAML==6.0.1
requests==2.32.3
tenacity==8.4.2
typing_extensions==4.12.2
urllib3==2.2.2

annotated-types==0.7.0

certifi==2024.6.2

charset-normalizer==3.3.2

idna==3.7

jsonpatch==1.33

jsonpointer==3.0.0

langchain-core==0.2.10

langchain-text-splitters==0.2.2

langsmith==0.1.82

orjson==3.10.5

packaging==24.1

pydantic==2.7.4

pydantic_core==2.18.4

PyYAML==6.0.1

requests==2.32.3

tenacity==8.4.2

typing_extensions==4.12.2

urllib3==2.2.2

※ pip

[PYTHON/LANGCHAIN] MarkdownHeaderTextSplitter 클래스 : 생성자에서 return_each_line 인자를 사용해 마크다운 라인별로 문서 리스트 구하기

■ MarkdownHeaderTextSplitter 클래스의 생성자에서 return_each_line 인자를 사용해 마크다운 라인별로 문서 리스트를 구하는 방법을 보여준다. ▶ main.py


from langchain_text_splitters import MarkdownHeaderTextSplitter

codeString = "# Foo\n\n    ## Bar\n\nHi this is Jim\n\nHi this is Joe\n\n ### Boo \n\n Hi this is Lance \n\n ## Baz\n\n Hi this is Molly"

headerListToSplitOn = [
    ("#"  , "Header 1"),
    ("##" , "Header 2"),
    ("###", "Header 3")
]

markdownHeaderTextSplitter = MarkdownHeaderTextSplitter(headerListToSplitOn, return_each_line = True)

documentList = markdownHeaderTextSplitter.split_text(codeString)

for document in documentList:
    print(document)

"""
page_content='Hi this is Jim' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}
page_content='Hi this is Joe' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}
page_content='Hi this is Lance' metadata={'Header 1': 'Foo', 'Header 2': 'Bar', 'Header 3': 'Boo'}
page_content='Hi this is Molly' metadata={'Header 1': 'Foo', 'Header 2': 'Baz'}
"""

from langchain_text_splitters import MarkdownHeaderTextSplitter

codeString = "# Foo\n\n ## Bar\n\nHi this is Jim\n\nHi this is Joe\n\n ### Boo \n\n Hi this is Lance \n\n ## Baz\n\n Hi this is Molly"

headerListToSplitOn = [

("#" , "Header 1"),

("##" , "Header 2"),

("###", "Header 3")

]

markdownHeaderTextSplitter = MarkdownHeaderTextSplitter(headerListToSplitOn, return_each_line = True)

documentList = markdownHeaderTextSplitter.split_text(codeString)

for document in documentList:

print(document)

"""

page_content='Hi this is Jim' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}

page_content='Hi this is Joe' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}

page_content='Hi this is Lance' metadata={'Header 1': 'Foo', 'Header 2': 'Bar', 'Header 3': 'Boo'}

page_content='Hi this is Molly' metadata={'Header 1': 'Foo', 'Header 2': 'Baz'}

"""

▶ requirements.txt


annotated-types==0.7.0
certifi==2024.6.2
charset-normalizer==3.3.2
idna==3.7
jsonpatch==1.33
jsonpointer==3.0.0
langchain-core==0.2.10
langchain-text-splitters==0.2.2
langsmith==0.1.82
orjson==3.10.5
packaging==24.1
pydantic==2.7.4
pydantic_core==2.18.4
PyYAML==6.0.1
requests==2.32.3
tenacity==8.4.2
typing_extensions==4.12.2
urllib3==2.2.2

annotated-types==0.7.0

certifi==2024.6.2

charset-normalizer==3.3.2

idna==3.7

jsonpatch==1.33

jsonpointer==3.0.0

langchain-core==0.2.10

langchain-text-splitters==0.2.2

langsmith==0.1.82

orjson==3.10.5

packaging==24.1

pydantic==2.7.4

pydantic_core==2.18.4

PyYAML==6.0.1

requests==2.32.3

tenacity==8.4.2

typing_extensions==4.12.2

urllib3==2.2.2

※ pip

[PYTHON/LANGCHAIN] MarkdownHeaderTextSplitter 클래스 : split_text 메소드를 사용해 마크다운 문자열에서 문서 리스트 구하기

■ MarkdownHeaderTextSplitter 클래스의 split_text 메소드를 사용해 마크다운 문자열에서 문서 리스트를 구하는 방법을 보여준다. ▶ main.py


from langchain_text_splitters import MarkdownHeaderTextSplitter

codeString = "# Foo\n\n    ## Bar\n\nHi this is Jim\n\nHi this is Joe\n\n ### Boo \n\n Hi this is Lance \n\n ## Baz\n\n Hi this is Molly"

headerListToSplitOn = [
    ("#"  , "Header 1"),
    ("##" , "Header 2"),
    ("###", "Header 3")
]

markdownHeaderTextSplitter = MarkdownHeaderTextSplitter(headerListToSplitOn)

documentList = markdownHeaderTextSplitter.split_text(codeString)

for document in documentList:
    print(document)

"""
page_content='Hi this is Jim  \nHi this is Joe' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}
page_content='Hi this is Lance' metadata={'Header 1': 'Foo', 'Header 2': 'Bar', 'Header 3': 'Boo'}
page_content='Hi this is Molly' metadata={'Header 1': 'Foo', 'Header 2': 'Baz'}
"""

from langchain_text_splitters import MarkdownHeaderTextSplitter

codeString = "# Foo\n\n ## Bar\n\nHi this is Jim\n\nHi this is Joe\n\n ### Boo \n\n Hi this is Lance \n\n ## Baz\n\n Hi this is Molly"

headerListToSplitOn = [

("#" , "Header 1"),

("##" , "Header 2"),

("###", "Header 3")

]

markdownHeaderTextSplitter = MarkdownHeaderTextSplitter(headerListToSplitOn)

documentList = markdownHeaderTextSplitter.split_text(codeString)

for document in documentList:

print(document)

"""

page_content='Hi this is Jim \nHi this is Joe' metadata={'Header 1': 'Foo', 'Header 2': 'Bar'}

page_content='Hi this is Lance' metadata={'Header 1': 'Foo', 'Header 2': 'Bar', 'Header 3': 'Boo'}

page_content='Hi this is Molly' metadata={'Header 1': 'Foo', 'Header 2': 'Baz'}

"""

▶ requirements.txt


annotated-types==0.7.0
certifi==2024.6.2
charset-normalizer==3.3.2
idna==3.7
jsonpatch==1.33
jsonpointer==3.0.0
langchain-core==0.2.10
langchain-text-splitters==0.2.2
langsmith==0.1.82
orjson==3.10.5
packaging==24.1
pydantic==2.7.4
pydantic_core==2.18.4
PyYAML==6.0.1
requests==2.32.3
tenacity==8.4.2
typing_extensions==4.12.2
urllib3==2.2.2

annotated-types==0.7.0

certifi==2024.6.2

charset-normalizer==3.3.2

idna==3.7

jsonpatch==1.33

jsonpointer==3.0.0

langchain-core==0.2.10

langchain-text-splitters==0.2.2

langsmith==0.1.82

orjson==3.10.5

packaging==24.1

pydantic==2.7.4

pydantic_core==2.18.4

PyYAML==6.0.1

requests==2.32.3

tenacity==8.4.2

typing_extensions==4.12.2

urllib3==2.2.2

※ pip install

[PYTHON/LANGCHAIN] RecursiveCharacterTextSplitter 클래스 : create_documents 메소드를 사용해 마크다운 문자열에서 문서 리스트 구하기

■ RecursiveCharacterTextSplitter 클래스를 사용해 create_documents 메소드를 사용해 마크다운 문자열에서 문서 리스트를 구하는 방법을 보여준다. ▶ main.py


from langchain.text_splitter import RecursiveCharacterTextSplitter
from langchain.text_splitter import Language

codeString = """
# 🦜️🔗 LangChain

⚡ Building applications with LLMs through composability ⚡

## Quick Install

```bash
# Hopefully this code block isn't split
pip install langchain
```

As an open-source project in a rapidly developing field, we are extremely open to contributions.
"""

recursiveCharacterTextSplitter = RecursiveCharacterTextSplitter.from_language(language = Language.MARKDOWN, chunk_size = 60, chunk_overlap = 0)

documentList = recursiveCharacterTextSplitter.create_documents([codeString])

print(documentList)

"""
[Document(page_content='# 🦜️🔗 LangChain'), Document(page_content='⚡ Building applications with LLMs through composability ⚡'), Document(page_content='## Quick Install\n\n```bash'), Document(page_content="# Hopefully this code block isn't split"), Document(page_content='pip install langchain'), Document(page_content='```'), Document(page_content='As an open-source project in a rapidly developing field, we'), Document(page_content='are extremely open to contributions.')]
"""

from langchain.text_splitter import RecursiveCharacterTextSplitter

from langchain.text_splitter import Language

codeString = """

# 🦜️🔗 LangChain

⚡ Building applications with LLMs through composability ⚡

## Quick Install

```bash

# Hopefully this code block isn't split

pip install langchain

```

As an open-source project in a rapidly developing field, we are extremely open to contributions.

"""

recursiveCharacterTextSplitter = RecursiveCharacterTextSplitter.from_language(language = Language.MARKDOWN, chunk_size = 60, chunk_overlap = 0)

documentList = recursiveCharacterTextSplitter.create_documents([codeString])

print(documentList)

"""

[Document(page_content='# 🦜️🔗 LangChain'), Document(page_content='⚡ Building applications with LLMs through composability ⚡'), Document(page_content='## Quick Install\n\n```bash'), Document(page_content="# Hopefully this code block isn't split"), Document(page_content='pip install langchain'), Document(page_content='```'), Document(page_content='As an open-source project in a rapidly developing field, we'), Document(page_content='are extremely open to contributions.')]

"""

▶ requirements.txt


aiohttp==3.9.5
aiosignal==1.3.1
annotated-types==0.7.0
async-timeout==4.0.3
attrs==23.2.0
certifi==2024.6.2
charset-normalizer==3.3.2
frozenlist==1.4.1
greenlet==3.0.3
idna==3.7
jsonpatch==1.33
jsonpointer==3.0.0
langchain==0.2.6
langchain-core==0.2.10
langchain-text-splitters==0.2.2
langsmith==0.1.82
multidict==6.0.5
numpy==1.26.4
orjson==3.10.5
packaging==24.1
pydantic==2.7.4
pydantic_core==2.18.4
PyYAML==6.0.1
requests==2.32.3
SQLAlchemy==2.0.31
tenacity==8.4.2
typing_extensions==4.12.2
urllib3==2.2.2
yarl==1.9.4

aiohttp==3.9.5

aiosignal==1.3.1

annotated-types==0.7.0

async-timeout==4.0.3

attrs==23.2.0

certifi==2024.6.2

charset-normalizer==3.3.2

frozenlist==1.4.1

greenlet==3.0.3

idna==3.7

jsonpatch==1.33

jsonpointer==3.0.0

langchain==0.2.6

langchain-core==0.2.10

langchain-text-splitters==0.2.2

langsmith==0.1.82

multidict==6.0.5

numpy==1.26.4

orjson==3.10.5

packaging==24.1

pydantic==2.7.4

pydantic_core==2.18.4

PyYAML==6.0.1

requests==2.32.3

SQLAlchemy==2.0.31

tenacity==8.4.2

typing_extensions==4.12.2

urllib3==2.2.2

yarl==1.9.4

※ pip