nifi-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bryan Rosander <bryanrosan...@gmail.com>
Subject [DISCUSS] - Markdown option for documentation artifacts
Date Tue, 07 Jun 2016 18:28:29 GMT
Hey all,

When writing documentation (e.g. the additionalDetails.html for a
processor) it would be nice to have the option to use Markdown instead of
html.

I think Markdown is easier to read and write than raw HTML and for simple
cases does the job pretty well.  It also has the advantage of being able to
be translated into other document types easily and it would be rendered by
default in Github when the file is clicked.

There is an MIT-licensed Markdown maven plugin (
https://github.com/walokra/markdown-page-generator-plugin) that seems like
it might work for translating additionalDetails.md (and others) into an
equivalent html page.

Thanks,
Bryan Rosander

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message