MartinDown

A MarkDown parser that only supports span elements.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

There are multiple ways to build this project. This guide will be using the .NET Core command-line interface (CLI) tools.

Installing

cd ./src
dotnet restore
dotnet build

Demo

This is how you would use MartinDown in your project.

using System;

namespace Godreault.MartinDown
{
    public class Program
    {
        static void Main(string[] args) 
        {
            MartinDown martinDown = new MartinDown();
            Console.WriteLine(martinDown.Transform("**Hello World!**"));
        }
    }
}

Running the tests

Here's how to run the automated tests for this MartinDown.

cd ./tests/
dotnet restore
dotnet test

Contributing

Contributions are absolutely welcome! The project is built as a .NET Core library. You'll need to download this to build the project.

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Jerad Godreault - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details