deltaspike-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Romain Manni-Bucau <rmannibu...@gmail.com>
Subject Re: [suggestion] - Documentation
Date Wed, 25 Jul 2012 16:05:52 GMT
Hmm, these feedbacks are really relevant and should be pushed to infra i
think, no?

it is simply a matter of adding some hooks in the cms but i think it is
better to had them in the cms instead of "by project"

wdyt?

- Romain


2012/7/25 Pete Muir <pmuir@redhat.com>

>
> On 25 Jul 2012, at 16:36, Matt Benson wrote:
>
> > On Wed, Jul 25, 2012 at 10:22 AM, Pete Muir <pmuir@redhat.com> wrote:
> >>
> >> On 25 Jul 2012, at 16:16, Matt Benson wrote:
> >>
> >>> On Wed, Jul 25, 2012 at 8:58 AM, Pete Muir <pmuir@redhat.com> wrote:
> >>>>
> >>>> On 25 Jul 2012, at 07:17, Mark Struberg wrote:
> >>>>
> >>>>> David, the CMS is already set up and running (in SVN [1]). We just
> need a bit more stylish css.
> >>>>>
> >>>>> And you can perfectly create pdf docs out of markdown.
> >>>>>
> >>>>> Of course we can also use alternative formats. But to me this is
> like a colour preference - markdown is supported out of the box and
> provides all needed options.
> >>>>
> >>>> My only concern here is that Markdown doesn't support a few useful
> things for full on docs (vs readmes and snippets of text):
> >>>
> >>> FWIW,
> >>>>
> >>>> * admonitions
> >>> I.e., warnings?  What are you looking for here?
> >>
> >> Yes, admonitions is the term given (I think by docbook) to the boxouts
> that are e.g. Warning, Info, Important.
> >>
> >>>
> >>>> * callouts on code
> >>> Again, not sure I know what you're meaning here.
> >>
> >> I can have a little icon (e.g. a 1), next to a line of code, then a
> table at the bottom of the codeblock that links to that. Allows you to
> annotate a code block with notes.
> >>
> >>>
> >>>> * a standard way of indicating what the source language of a code
> block is
> >>> Apache CMS has this.
> >>
> >> Cool. How would this work if we were also producing pdfs and epubs? Is
> this a standard extension to markdown?
> >
> > Yes; the code highlighting is done with
> > http://freewisdom.org/projects/python-markdown/CodeHilite; depending
> > on the structure of whatever mechanism would be theoretically used to
> > produce other formats, we'd presumably just make the same extensions
> > available.
>
> That works :-)
>
>

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