So can it generate HTML during build process? I want the ability to have generated docs that can be distributed.
On Sat, Aug 20, 2011 at 12:19 AM, Marc Grue <[email protected]> wrote: > Could we use Githubs Gollum? That way I suppose we can both get versioned but > also branched docs ie let the documentation follow the different branches > independently so that a new feature in development can be documented without > disturbing the latest release docs etc. Furthermore Gollum allows to browse > the docs offline, then update and merge like any git repo... > > (I haven't forgot my other thread about documentation - working on finishing > off the DCI sample first) > > Cheers > Marc > > Sent from my iPhone > > On 18 aug 2011, at 08:51, Niclas Hedhman <[email protected]> wrote: > >> Qi4j Gang, (OPS4J gang is added for potential feedback) >> >> Since we need to get going on 2.0 docs, we need to decide on the tool to use. >> >> >> Personally I would favor some type of "markdown" syntax, written in >> ordinary text files under Git control. >> >> GitHub itself has GFM[1] (GitHub Flavoured Markdown) which is >> influence by John Gruber's markdown[2] >> >> One advantage of using that would be that it is browsable from >> www.github.com html pages. And I think it would technically be >> possible to direct all http://www.qi4j.org/documentation to some area >> on GitHub (need to be verified). >> >> BUT that said, I would like to hear other ideas. >> >> Mind you; I kind of think that any "wiki" setup (be it SiteVision or >> Confluence) is outright "wrong" by definition, since it is not easily >> versioned alongside the code it describes. >> >> >> [1] http://github.github.com/github-flavored-markdown/ >> [2] http://daringfireball.net/projects/markdown/syntax >> >> >> Cheers >> -- >> Niclas Hedhman, Software Developer >> http://www.qi4j.org - New Energy for Java >> >> I live here; http://tinyurl.com/3xugrbk >> I work here; http://tinyurl.com/24svnvk >> I relax here; http://tinyurl.com/2cgsug >> >> _______________________________________________ >> qi4j-dev mailing list >> [email protected] >> http://lists.ops4j.org/mailman/listinfo/qi4j-dev > > _______________________________________________ > qi4j-dev mailing list > [email protected] > http://lists.ops4j.org/mailman/listinfo/qi4j-dev > -- Niclas Hedhman, Software Developer http://www.qi4j.org - New Energy for Java I live here; http://tinyurl.com/3xugrbk I work here; http://tinyurl.com/24svnvk I relax here; http://tinyurl.com/2cgsug _______________________________________________ qi4j-dev mailing list [email protected] http://lists.ops4j.org/mailman/listinfo/qi4j-dev
