Richard North's Blog

Dropwizard Markdown assets bundle

I just released a small library which adds Markdown rendering support for assets served by a Dropwizard application.

The main goal is to make it quicker and easier to serve API documentation alongside a service, without having to set up a separate HTML authoring /generation process. Markdown documents on the classpath can simply be served up in crisp rendered HTML. I like the idea of a service self-hosting its own documentation, whether it's for internal or public consumption.

Additionally, this bundle adds support for the awesome MermaidJS and highlight.js libraries, which enable quick and easy embedding of diagrams and highlighted code snippets in your documentation. Here's how it looks:

Screenshot of rendered docs
Screenshot of rendered docs

Please check out the project on GitHub here:

There is additionally a small demo site hosted here:

← Home