nifi-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bryan Rosander <bryanrosan...@gmail.com>
Subject Re: [DISCUSS] - Markdown option for documentation artifacts
Date Sat, 16 Jul 2016 18:18:21 GMT
Hey Joe,

I can definitely write one up.

Thanks,
Bryan

On Jul 15, 2016 10:43 PM, "Joe Witt" <joe.witt@gmail.com> wrote:

> Just wanted to bump this thread.  Looked like a lot of folks liked the
> idea.  Do you plan to file a JIRA for this Bryan?
>
> On Thu, Jun 9, 2016 at 8:39 AM, Joe Skora <jskora@gmail.com> wrote:
> > +1
> >
> > On Wed, Jun 8, 2016 at 10:40 AM, Matt Burgess <mattyb149@gmail.com>
> wrote:
> >
> >> +1 with template
> >>
> >> On Wed, Jun 8, 2016 at 10:39 AM, dan bress <danbress@gmail.com> wrote:
> >> > +1
> >> >
> >> > On Wed, Jun 8, 2016 at 7:05 AM Andre <andre-lists@fucs.org> wrote:
> >> >
> >> >> +1 on this + a template that matches existing additional.html
> >> >> On 8 Jun 2016 04:28, "Bryan Rosander" <bryanrosander@gmail.com>
> wrote:
> >> >>
> >> >> > 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