Git Product home page Git Product logo

discountcpp's Introduction

#DiscountCpp

C++11 wrapper for the C markdown library Discount.

Currently implements very few functions from Discount, but offers a very easy-to-use interface to quickly convert Markdown to HTML.

##Global functions (fire and forget)

Easy-to-use functions that convert Markdown strings/files to HTML strings/files.

namespace discountcpp
{
	// Returns a string containing HTML code converted from an input string containing Markdown code
	std::string getHTMLFromMarkdownString(const std:string& mMarkdownString);

	// Returns a string containing HTML code converted from an input path to a Markdown file
	std::string getHTMLFromMarkdownFile(const std::string& mMarkdownFilePath);

	// Writes an HTML file to an input path from an input string containing Markdown code
	void writeHTMLFileFromMarkdownString(const std::string& mHTMLFilePath, const std::string& mMarkdownString);
		
	// Writes an HTML file to an input path from an input path to a Markdown file
	void writeHTMLFileFromMarkdownFile(const std::string& mHTMLFilePath, const std::string& mMarkdownFilePath);
}

Example usage:

std::string writeBlogHTML()
{
	std::string resultPage;

	for(const auto& markdownEntryPath : getBlogMarkdownEntryPaths())	
		resultPage += discountcpp::getHTMLFromMarkdownFile(markdownEntryPath);
		
	return resultPage;
}

##Objects

namespace discountcpp
{
	class Source; // Markdown source 
	class Document; // Markdown document
}

discountcpp::Source can read Markdown code from strings or files.

discountcpp::Document must be constructed with a discountcpp::Source, and can generate HTML strings or files.

Example usage:

std::string writeBlogHTML()
{
	std::string resultPage;

	for(const auto& markdownEntryPath : getBlogMarkdownEntryPaths())	
	{
		discountcpp::Source source;
		source.readFromFile(markdownEntryPath);

		// Using the same document to output both to string and both to file
		discountcpp::Document document{source};
		string outputHTML;
		document.writeHTMLToString(outputHTML);
		document.writeHTMLToFile(markdownEntryPath + ".tmp.html");

		resultPage += outputHTML;
	}
		
	return resultPage;
}

discountcpp's People

Contributors

vittorioromeo avatar

Watchers

deger avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.