[jira] (LOG4J2-1802) Convert documentation into Markdown

[Matt Sicker (JIRA)]

Title: Message Title

Matt Sicker created an issue   Log4j 2 / LOG4J2-1802 Convert documentation into Markdown Issue Type: Documentation Assignee: Matt Sicker Components: Documentation Created: 29/Jan/17 18:09 Priority: Major Reporter: Matt Sicker The xdoc system currently in place is difficult to use correctly (it expects proper XHTML, no block level elements inside inline level elements, the usual pedantry from an XHTML/XML validator) and is needlessly verbose for writing documentation. The plugin we already use (maven-site-plugin) supports Markdown as an alternative (amongst others). Most text can be formatted as plain Markdown which simplifies the format a bit, plus anything complex can still be written in regular HTML (e.g., special tables). This will also allow for the documentation to be viewable on GitHub (at least for non-templated files) as seen in this example page. I suggest using Markdown instead of something like Asciidoc as it's simpler to convert from xdoc and because I'm far more experienced with the syntax. Add Comment   This message was sent by Atlassian JIRA (v6.3.15#6346-sha1:dbc023d)