Richard North’s Blog

Dropwizard Markdown as­sets bun­dle

I just re­leased a small li­brary which adds Markdown ren­der­ing sup­port for as­sets served by a Dropwizard ap­pli­ca­tion.

The main goal is to make it quicker and eas­ier to serve API doc­u­men­ta­tion along­side a ser­vice, with­out hav­ing to set up a sep­a­rate HTML au­thor­ing /generation process. Markdown doc­u­ments on the class­path can sim­ply be served up in crisp ren­dered HTML. I like the idea of a ser­vice self-host­ing its own doc­u­men­ta­tion, whether it’s for in­ter­nal or pub­lic con­sump­tion.

Additionally, this bun­dle adds sup­port for the awe­some MermaidJS and high­light.js li­braries, which en­able quick and easy em­bed­ding of di­a­grams and high­lighted code snip­pets in your doc­u­men­ta­tion. Here’s how it looks:

Screenshot of rendered docs
Screenshot of ren­dered docs

Please check out the pro­ject on GitHub here: https://​​rnorth/​drop­wiz­ard-mark­down-as­sets-bun­dle

There is ad­di­tion­ally a small demo site hosted here: https://​drop­wiz­ard-mark­​docs/

← Home