Fork of maddy, a C++ Markdown to HTML header-only parser library.
Go to file
M. Petra Baranski 91e62beaec added travis.yml 2017-12-26 11:42:57 +01:00
docs initial release 1.0.0 2017-12-25 12:22:35 +01:00
include/maddy fixed the inline code now also for not directly following letters 2017-12-26 05:24:01 +01:00
libs initial release 1.0.0 2017-12-25 12:22:35 +01:00
tests added travis.yml 2017-12-26 11:42:57 +01:00
.editorconfig initial release 1.0.0 2017-12-25 12:22:35 +01:00
.gitignore initial release 1.0.0 2017-12-25 12:22:35 +01:00
.gitmodules initial release 1.0.0 2017-12-25 12:22:35 +01:00
.travis.yml added travis.yml 2017-12-26 11:42:57 +01:00
AUTHORS initial release 1.0.0 2017-12-25 12:22:35 +01:00
CMakeLists.txt added travis.yml 2017-12-26 11:42:57 +01:00
ISSUE_TEMPLATE.md Created Github issue template 2017-12-25 13:45:45 +01:00
LICENSE initial release 1.0.0 2017-12-25 12:22:35 +01:00
README.md updated version 2017-12-26 05:25:02 +01:00

README.md

maddy

License: MIT Version: 1.0.2

maddy is a C++ Markdown to HTML header-only parser library.

Supported OS

It actually should work on any OS, that supports the C++14 standard library.

It is tested to work on:

  • Linux (without exceptions and without RTTI)

Dependencies

  • C++14

Why maddy?

When I was needing a Markdown parser in C++ I couldn't find any, that was fitting my needs. So I simply wrote my own one.

Markdown syntax

The supported syntax can be found in the definitions docs.

HowTo use

To use maddy in your project, simply add the include path of maddy to yours and in the code, you can then do the following:

#include <memory>
#include <string>

#include "maddy/parser.h"

std::stringstream markdownInput("");
std::shared_ptr<maddy::Parser> parser = std::make_shared<maddy::Parser>();
std::string htmlOutput = parser->Parse(markdownInput);

How to contribute

There are different possibilities:

  • Create a GitHub issue
  • Create a pull request with an own branch (don't forget to put yourself in the AUTHORS file)