maybe we can use http://jekyllrb.com/

here you are an example http://docs.scala-lang.org/
and source code https://github.com/scala/scala.github.com



Date: Tue, 25 Mar 2014 13:55:43 +0100
From: matzew@apache.org
To: aerogear-dev@lists.jboss.org
Subject: Re: [aerogear-dev] [UnifiedPush Server] Documentation improvements ?




On Tue, Mar 25, 2014 at 1:53 PM, Lucas Holmquist <lholmqui@redhat.com> wrote:
did we discuss using the wiki,  or was that for something else

not sure - wiki is nice, but a real guide/book is really something I prefer for the "official" documentation.

wiki could be: 
setup up your XFVZ Database etc

 
On Mar 25, 2014, at 5:11 AM, Corinne Krych <corinnekrych@gmail.com> wrote:

>
> On 25 Mar 2014, at 08:55, Sebastien Blanc <scm.blanc@gmail.com> wrote:
>
>> +1
>> We got already almost all the material in the current readme and we can split that nicely into a howto and then rewriting maybe some parts.
>>
>>
>>
>> On Tue, Mar 25, 2014 at 7:33 AM, Matthias Wessendorf <matzew@apache.org> wrote:
>> Hi,
>>
>> I feel a bit of the documentation might be misleading and not always that great to go over.
>>
>> Instead of adding more and more the README, I think we should (w/in the REPO) start to write a guide/book on HOWTO.
>
> +1 to add the doc in the relevant repo
> We could alway inlude part of the ascidoc text in aerogear web site with the same mechanism as shown in this PR:
> https://github.com/aerogear/aerogear.org/pull/275
>
>
>>
>> Regarding the actual format, I think asciidoc comes to mind;
>>
>>
>> Any thoughts ?
>>
>>
>>
>> --
>> Matthias Wessendorf
>>
>> blog: http://matthiaswessendorf.wordpress.com/
>> sessions: http://www.slideshare.net/mwessendorf
>> twitter: http://twitter.com/mwessendorf
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev@lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev@lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev@lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev


_______________________________________________
aerogear-dev mailing list
aerogear-dev@lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev



--
Matthias Wessendorf

blog: http://matthiaswessendorf.wordpress.com/
sessions: http://www.slideshare.net/mwessendorf
twitter: http://twitter.com/mwessendorf

_______________________________________________ aerogear-dev mailing list aerogear-dev@lists.jboss.org https://lists.jboss.org/mailman/listinfo/aerogear-dev