Midnight dynamite readme

midnight_dynamite is a Nimrod wrapper around the hoedown C library which renders Markdown. The wrapper provides both the low level C API and a higher level convenience layer. The higher level API is not yet complete and offers only basic rendering features. Missing features like table of contents extraction or renderer customization will be provided in future releases.

On top of the library code, the midnight_dynamite_badger.exe program shows how to use the library and provides a simple practical Markdown to html command line tool.

License

MIT license.

Installing the library

Stable version

Install the Nimrod compiler. Then use Nimrod's Nimble package manager to install:

$ nimble update
$ nimble install midnight_dynamite

Development version

Install the Nimrod compiler. Then use Nimrod's Nimble package manager to install locally the github checkout:

$ git clone --recursive https://github.com/gradha/midnight_dynamite.git
$ cd midnight_dynamite
$ nimble install -y

If you don't mind downloading the git repo every time you can also use nimble to install the latest development version:

$ nimble update
$ nimble install -y midnight_dynamite@#head

Documentation

The midnight_dynamite_badger.exe binary has its own manual in docs/midnight_dynamite_badger_usage.md, but running the program with the --help switch should show enough help to get you going.

Generated versions of the documentation can be browsed online at http://gradha.github.io/midnight_dynamite/. You may also browse the tests directory for usage examples.

Programmer documentation is provided as docstrings, you can generate it yourself running the following commands:

$ cd `nimble path midnight_dynamite`
$ nimrod doc midnight_dynamite.nim
$ open midnight_dynamite.html

If you installed using git, run the nimrod doc command where you cloned the repo. Here is a minimal practical usage example:

import midnight_dynamite

when isMainModule:
  var md_params = init_md_params()
  finally: md_params.free
  md_params.render_file("README.md")

Changes

This is development version 1.0.1. For a list of changes see the docs/changes.md file. The hoedown version is 3.0.1.

Git branches

This project uses the git-flow branching model with reversed defaults. Stable releases are tracked in the stable branch. Development happens in the default master branch.

Feedback

You can send me feedback through GitHub's issue tracker. I also take a look from time to time to Nimrod's forums where you can talk to other nimrod programmers.