I recently did a bit of work with the markdown module, which is a good alternative to APT.
I'd be interested in exploring supporting GitHub Flavored Markdown so that you can mark up blocks a bit more: ```java ``` etc. - Brett On 18/10/2011, at 5:28 PM, Ivan Habunek wrote: > Hi, > > One problem with using APT for writing docs is that code can only be included > within the +-- tags. This is rendeder as two nested elements <div > class="source"><pre> Then you add the prettpyrint class by javascript to all > <pre> elements within <code> elements. > > This does not allow for non-prettified <pre> blocks and makes some pages look > pretty weird, e.g.: > http://people.apache.org/~olamy/maven/site/license.html > > The only reasonable alternative i discovered is using XDOC and specifying > your own blocks as either: > a) <pre> > b) <pre class="prettyprint"> > c) <pre class="prettyprint linenums"> > > This allows for much more flexibility, but requires usage of XDOC format to > have code prettification. APT +-- syntax always produces plain <pre> blocks. > > Again, the problem is that maven transforms <pre class="prettyprint"> to <div > class="prettyprint"><pre> (why o why?) but this can also be fixed by > javascript. > > To conclude, I'm migrating most of log4php docs to XDOC format because of > this and some other APT limitations. It is a bit more difficult to write, but > it is more flexible. > > If you like the solution I can transfer it to the sandbox. > > Regards, > Ivan > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org > For additional commands, e-mail: dev-h...@maven.apache.org > -- Brett Porter br...@apache.org http://brettporter.wordpress.com/ http://au.linkedin.com/in/brettporter --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org For additional commands, e-mail: dev-h...@maven.apache.org
