Re: APT vs Markdown formats for site docs

I looked for a few minutes at https://github.com/apache/logging-log4j2 and found 3 or 4 markdown pages under site that didn’t appear to have anything that would be hard to write in AsciiDoc. The root level pages such as README.md, if written in (limited) AsciiDoc, will display nicely at GitHub.

Re: APT vs Markdown formats for site docs

Asciidoctor Maven Tools is the more supported way of using Asciidoctor from maven, either directly or through Doxia. https://docs.asciidoctor.org/maven-tools/latest/ (docs) https://github.com/asciidoctor/asciidoctor-maven-plugin

Re: APT vs Markdown formats for site docs

Log4j didn’t switch everything. A couple pages had to be left as Markdown for things AsciiDoc doesn’t support, although at the moment I don’t remember what those things were at the moment. Ralph > On Feb 1, 2021, at 6:30 AM, Gary Gregory wrote: > > FYI, over at Log4j, we switched to Asciidoc.

Re: APT vs Markdown formats for site docs

FYI, over at Log4j, we switched to Asciidoc. Gary On Mon, Feb 1, 2021, 05:19 Artem Krosheninnikov < artem.krosheninni...@gmail.com> wrote: > Hello there, whilst looking at some docs in maven-enforcer-plugin, I found > .apt.vm format not very convenient and developer-friendly, especially for a >

Re: APT vs Markdown formats for site docs

FWIW Doxia supports Asciidoc pretty well. You just have to add an extra dependency for it to find Asciidoctorj, as demonstrated at https://github.com/kordamp/pomchecker/blob/master/pom.xml#L200-L227 You can mix all kind of supported formats if needed. Or use only asciidoc, the choice is yours ;-)

Re: APT vs Markdown formats for site docs

I agree that there are several implementations thus it may be not a good choice. FML looks very ancient from my point of view but asciidoc is more or less a standard format in docops community. It's not that everything should be immediately converted to another format, just trying to understand w

Re: APT vs Markdown formats for site docs

https://github.com/asciidoctor/jekyll-asciidoc-quickstart .. find “GitHub pages” in page. My blog used to be in textile - overnight GHP dropped support so I had to batch convert hundreds to markdown. That was years back. I might have preferred asciidoc, and if it is supported that’s great, but I d

Re: APT vs Markdown formats for site docs

Markdown is not a "standard" or "standardized". Even worse, different implementations have different feature sets. Thus my -1 for md. But another format might be feasible, really. fml looks verbose. Asciidoc might be a sane choice here. It was specially designed for technical documentation and ha

APT vs Markdown formats for site docs

Hello there, whilst looking at some docs in maven-enforcer-plugin, I found .apt.vm format not very convenient and developer-friendly, especially for a newcomer. Is it a standard for all maven plugins or were there any discussions on using another format? I see that maven-parent-34 has several modu