CatMarkdown

A simple Markdown parser and renderer for .NET

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage

About The Project

![Product Name Screen Shot][product-screenshot]

CatMarkdown is a simple Markdown parser and renderer for .NET. It converts Markdown text into HTML, supporting various Markdown features such as headings, lists, blockquotes, code blocks, and inline formatting.

(back to top)

Built With

• .NET 9.0

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• .NET 9.0 SDK

Installation

1. Clone the repo

   git clone https://github.com/github_username/repo_name.git

2. Navigate to the project directory

   cd repo_name

3. Restore dependencies

   dotnet restore

Usage

To use the Markdown parser and renderer, create instances of MarkdownParser and HTMLRenderer and call their methods:

using CatMarkdown.src.Parsing;
using CatMarkdown.src.Rendering;

var parser = new MarkdownParser();
var renderer = new HTMLRenderer();

string markdown = "# Hello, World!";
string parsedContent = parser.Parse(markdown);
string html = renderer.Render(parsedContent);

Console.WriteLine(html);