Re: [DISCUSS] Converting site documentation to Markdown

2013-10-16 Thread John Casey
I'll also offer up a project I've been playing with in my free time: https://github.com/jdcasey/freeki/ Not sure if it's useful for anything per se, but maybe inspires some hacking. On 10/6/13 10:20 AM, Jason van Zyl wrote: Here's a pretty good list of tools. The other two I've tried are Mar

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-16 Thread Dennis Lundberg
Hi Jason Which sites are you talking about? Do you mean maven-site (the project site), the site for maven-core and/or all the other 100+ sites for all of our plugins and components? My view on documentation is that the person who takes the time to write the documentation gets to choose the format

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-07 Thread Stephen Connolly
On Monday, 7 October 2013, Manfred Moser wrote: > > If I was choosing to write a technical book I would choose asciidoc. > > Agreed.. in fact asciidoc is the default markup tool at OReilly. I use it > for all the books as Sonatype including Maven: The Complete Reference and > Maven by Example.. >

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-07 Thread Manfred Moser
> If I was choosing to write a technical book I would choose asciidoc. Agreed.. in fact asciidoc is the default markup tool at OReilly. I use it for all the books as Sonatype including Maven: The Complete Reference and Maven by Example.. > AsciiDoc is the technically superior product that may wel

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Aldrin Leal
There's a great comprehensive list at http://staticsitegenerators.net (btw, I've wrote the jbake-maven-plugin, for jbake - https://github.com/jonbullock/JBake) -- -- Aldrin Leal, Master your EC2-fu! Get the latest ekaterminal public beta http://www.ingenieux.com.br/products/ekaterminal/ On Sun

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Jason van Zyl
Here's a pretty good list of tools. The other two I've tried are Marked (which is another MAC app), but I've also tried dillinger.io which is web-based editor and it's quite good. There are quite a few web-based tools that provide similar capabilities to Mou. http://mashable.com/2013/06/24/mark

RE: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Tanveer Ahmad
List Subject: Re: [DISCUSS] Converting site documentation to Markdown Regarding automatic conversion to Markdown: The main ASF site was converted from xdoc to Markdown. Some tools werr written for this, but they were not 100% accurate; we were still finding conversion issues a year or so later

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread sebb
Regarding automatic conversion to Markdown: The main ASF site was converted from xdoc to Markdown. Some tools werr written for this, but they were not 100% accurate; we were still finding conversion issues a year or so later. [We've probably not found them all yet] Whether these conversion issues

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Hervé BOUTEMY
FML is used in a few places, not only main sites [1] but plugins and components too [2] So perhaps FML will remain until we find some macro tooling. I prefer keeping FML than maintaing index by hand If we can replace apt and xdoc, that will already be a good step Regards, Hervé [1] http://mav

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Hervé BOUTEMY
ok for the rationale Markdown seems to have been chosen in Apache CMS too [1] DOXIA-472 is a show stopper IMHO for the moment: I hope someone will fix it Stephen wrote about asciidoc, but it is not supported by Doxia at the moment [2], so not an option until someone adds this format to Doxia For

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Kristian Rosenvold
2013/10/6 Stephen Connolly : >> IMHO >> >> Betamax == AsciiDoc >> VHS == MarkDown Being a bunch of old geezers, we all know which was technically superior. I had to teach my oldest kid how to operate a non-mobile phone the other day (she dialled number before lifting the handset) Kristian -

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Jason van Zyl
On Oct 6, 2013, at 3:13 AM, Mirko Friedenhagen wrote: > Hello there, > > just my 2 cents: > > * I do not understand what is that bad about xdoc which is almost HTML. And > having a XSD/DTD code completion is available. > It's not bad, per se. It's really about the prevalence of good editors.

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Stephen Connolly
Sent from my iPhone > On 6 Oct 2013, at 08:44, Stephen Connolly > wrote: > > > >> On Sunday, 6 October 2013, Mirko Friedenhagen wrote: >> Hello there, >> >> just my 2 cents: >> >> * I do not understand what is that bad about xdoc which is almost HTML. And >> having a XSD/DTD code completi

[DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Stephen Connolly
On Sunday, 6 October 2013, Mirko Friedenhagen wrote: > Hello there, > > just my 2 cents: > > * I do not understand what is that bad about xdoc which is almost HTML. And > having a XSD/DTD code completion is available. It's ugly (remember beauty is in the eye of the beholder) > > * *All* freest

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-06 Thread Mirko Friedenhagen
Hello there, just my 2 cents: * I do not understand what is that bad about xdoc which is almost HTML. And having a XSD/DTD code completion is available. * *All* freestyle markup languages are ugly and hard to remember (I have to use TWiki/FosWiki and JIRA inhouse) * So getting rid of APT looks

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Jason van Zyl
I'm not saying we tell people not to use it, but for us I don't think it's an issue. It's been years since anything significant has been added to our FAQ and they are few enough that they can be converted by hand to add a TOC. I just want to make working with our documentation a little more enjo

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Robert Scholte
https://jira.codehaus.org/browse/DOXIA-472 ? No, still not fixed. IMHO the fml can only be replaced if there's a macro to generate an index of all the questions. Robert Op Sat, 05 Oct 2013 22:59:42 +0200 schreef Stephen Connolly : Has the page title problem been fixed? Last I checked y

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Stephen Connolly
Has the page title problem been fixed? Last I checked you could not set the page title that Doxia generates for HTML pages generated from markdown (Crosses fingers that it is fixed) On Saturday, 5 October 2013, Jason van Zyl wrote: > We current have multiple formats for our site documentation a

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Jason van Zyl
Tools are already there, just read from one format and write to another using Doxia. I'm definitely not going to do it manually. On Oct 5, 2013, at 1:28 PM, Kristian Rosenvold wrote: > If we were to deprecate one or more documentation formats, wouldn't it > make sense to make a plugin to auto

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Kristian Rosenvold
If we were to deprecate one or more documentation formats, wouldn't it make sense to make a plugin to automate the conversion ? After all, there's a few thousand sites out there that might want such a modernization ? Kristian 2013/10/5 Tamás Cservenák : > +10 for markdown and getting rid of old

Re: [DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Tamás Cservenák
+10 for markdown and getting rid of old formats. Markdown is really easy, and as Jason says, tooling for editing it is really superb. Thanks, ~t~ (mobile) On Oct 5, 2013 5:19 PM, "Jason van Zyl" wrote: > We current have multiple formats for our site documentation and two of > them no one else in

[DISCUSS] Converting site documentation to Markdown

2013-10-05 Thread Jason van Zyl
We current have multiple formats for our site documentation and two of them no one else in the world uses except us. We created xdoc here a long time ago in the Jakarta project, and APT has lost in the world of markup. I ported it from another project many years ago but there are many better opt