Miniature markdown library
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
snap
.gitignore
DOCUMENTATION.md
LICENSE
Makefile
NOTICE
README.md
mmd-128.png
mmd.c
mmd.h
mmd.opacity
mmdutil.c
mmdutil.md
testmmd.c
testmmd.md

README.md

mmd

mmd is a miniature markdown parsing "library" consisting of a single C source file and accompanying header file. mmd mostly conforms to the CommonMark version of markdown syntax with the following exceptions:

  • Embedded HTML markup and entities are explicitly not supported or allowed; the reason for this is to better support different kinds of output from the markdown "source", including XHTML, man, and xml2rfc.

  • Link reference definitions are not supported; these probably will be supported in a future version of the parsing code but will need explicit support in any output code to resolve the references.

  • Link titles are silently ignored.

  • Thematic breaks using a mix of whitespace and the separator character are not supported ("* * * *", "-- -- -- --", etc.); these could conceivably be added but did not seem particularly important.

In addition, mmd supports a couple (otherwise undocumented) CommonMark extensions:

  • Metadata as used by Jekyll and other web markdown solutions.

  • "@" links which resolve to headings within the file.

  • Tables.

mmd also includes a standalone utility called mmdutil that can be used to generate HTML and man page source from markdown.

I'm providing mmd as open source under the Apache License Version 2.0 with exceptions for use with GPL2/LGPL2 applications which allows you do pretty much do whatever you like with it. Please do provide feedback and report bugs to the Github project page at:

https://github.com/michaelrsweet/mmd

so that everyone can benefit.

Requirements

You'll need a C compiler.

How to Incorporate in Your Project

Add the mmd.c and mmd.h files to your project. Include the mmd.h header in any file that needs to read/convert markdown files.

"Kicking the Tires"

The supplied makefile allows you to build the unit tests on Linux and macOS (at least), which verify that all of the functions work as expected to produce a HTML file called testmmd.html:

make

The makefile also builds the mmdutil program.

Installing mmdutil

You can install the mmdutil program by copying it to somewhere appropriate or run:

make install

to install it in /usr/local along with a man page.

Changes in vCURRENT

The following changes were made for v1.4:

  • Fixed a table parsing bug where trailing pipes would add empty cells on the right side.
  • Tweaked the mmdutil program's default HTML stylesheet.
  • Fixed some Clang static analyzer warnings in mmd.c.
  • Fixed a build issue with Visual Studio.

Changes in v1.3

The following changes were made for v1.3:

  • Added mmdCopyAllText function that returns all of the text under the given node.
  • Added mmdutil program for converting markdown to HTML and man files.

Changes in v1.2

The following changes were made for v1.2:

  • Changed license to Apache License Version 2.0
  • Added support for markdown tables (Issue #3)

Changes in v1.1

The following changes were made for v1.1:

  • The mmd.h header now includes the C++ extern "C" wrapper around the C function prototypes.
  • Added a mmdLoadFile function that loads a markdown document from a FILE pointer.
  • Fixed a parsing bug for emphasized, bold, and code text containing whitespace.
  • Fixed a parsing bug for escaped characters followed by unescaped formatting sequences.
  • Fixed a parsing bug for headings that follow a list.

Legal Stuff

Copyright © 2017-2018 by Michael R Sweet.

mmd is licensed under the Apache License Version 2.0 with an exception to allow linking against GPL2/LGPL2 software (like older versions of CUPS). See the files "LICENSE" and "NOTICE" for more information.