Doxia – Introduction

<!DOCTYPE html>  <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> <meta name="author" content="Jason van Zyl Vincent Siveton" /> <meta name="date" content="2010-05-28" /> <title>Doxia – Introduction</title> <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> <script src="./js/apache-maven-fluido-1.12.0.min.js"></script>  <script> var _paq = window._paq = window._paq || []; _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="https://analytics.apache.org/"; _paq.push(['setTrackerUrl', u+'/matomo.php']); _paq.push(['setSiteId', '3']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'/matomo.js'; s.parentNode.insertBefore(g,s); })(); </script>  </head> <body> <div class="container-fluid container-fluid-top"> <header> <div id="banner"> <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../images/apache-maven-project.png" style="" /></a></div> <div class="pull-right"><a href="./" id="bannerRight"><img src="images/doxia-logo.png" alt="Doxia" style="" /></a></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> <li><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> <li><a href="index.html" title="Doxia">Doxia</a><span class="divider">/</span></li> <li class="active ">Introduction <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/index.apt.vm"><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-11-05</li> <li class="pull-right"><a href="scm.html" title="Get Sources">Get Sources</a></li> </ul> </div> </header> <div class="row-fluid"> <header id="leftColumn" class="span2"> <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">About Doxia</li> <li class="active"><a><span class="none"></span>What is Doxia?</a></li> <li><a href="overview.html" title="Overview"><span class="none"></span>Overview</a></li> <li><a href="downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> <li class="nav-header">Documentation</li> <li><a href="references/index.html" title="Format References"><span class="icon-chevron-right"></span>Format References</a></li> <li><a href="modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> <li><a href="macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> <li><a href="book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> <li><a href="issues/index.html" title="Issues &amp; Gotchas"><span class="none"></span>Issues &amp; Gotchas</a></li> <li><a href="resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> <li class="nav-header">Developer Docs</li> <li><a href="developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> <li><a href="doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> <li class="nav-header">Project Documentation</li> <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-down"></span>Project Information</a> <ul class="nav nav-list"> <li class="active"><a><span class="none"></span>About</a></li> <li><a href="team.html" title="Team"><span class="none"></span>Team</a></li> <li><a href="mailing-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li> <li><a href="scm.html" title="Source Code Management"><span class="none"></span>Source Code Management</a></li> <li><a href="issue-management.html" title="Issue Management"><span class="none"></span>Issue Management</a></li> <li><a href="ci-management.html" title="CI Management"><span class="none"></span>CI Management</a></li> </ul></li> <li class="nav-header">Maven Projects</li> <li><a href="../ref/current" title="Maven"><span class="none"></span>Maven</a></li> <li><a href="../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> <li><a href="../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> <li><a href="../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> <li><a href="../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> <li><a href="../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> <li><a href="" title="Components"><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> <li><a href="../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> <li><a href="../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> <li class="active"><a><span class="none"></span>Doxia</a></li> <li><a href="../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> <li><a href="../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> <li><a href="../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> <li><a href="../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> <li><a href="../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> <li><a href="../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> <li><a href="../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> <li><a href="../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> <li><a href="../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> <div class="clear"></div> <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> </div> </div> </header> <main id="bodyColumn" class="span10" > <section> <h2><a name="Maven_Doxia"></a>Maven Doxia</h2> <p>Doxia is a content generation framework which aims to provide its users with powerful techniques for generating static and dynamic content: Doxia can be used in web-based publishing context to generate static sites, in addition to being incorporated into dynamic content generation systems like blogs, wikis and content management systems.</p> <p>Doxia supports <a href="./references/index.html">markup languages with simple syntaxes</a>. Lightweight markup languages are used by people who might be expected to read the document source as well as the rendered output.</p> <p>Doxia is used extensively by <a class="externalLink" href="http://maven.apache.org">Maven</a> and it powers the entire documentation system of Maven. It gives Maven the ability to take any document that Doxia supports and output it any format.</p> <p>The current version of <a href="./doxia/">Doxia base framework</a> is 1.12.0.</p><section> <h3><a name="Brief_History"></a>Brief History</h3> <p>Based on the (now defunct) Aptconvert project developed by <a class="externalLink" href="http://www.xmlmind.com/">Xmlmind</a>, Doxia was initially hosted by <a class="externalLink" href="http://codehaus.org/">Codehaus</a>, to become a sub-project of Maven early in 2006.</p></section><section> <h3><a name="Main_Features"></a>Main Features</h3> <ul> <li>Developed in Java</li> <li><a href="./references/index.html">Support of several markup formats</a>: APT (Almost Plain Text), Confluence, Simplified DocBook, Markdown, FML (FAQ Markup Language), FO, iText, LaTeX, RTF, TWiki, XDoc (popular in Apache land), XHTML</li> <li>Easy to <a href="./modules/index.html">learn the syntax of the supported markup formats</a></li> <li>Macro support</li> <li>No need to have a corporate infrastructure (like wiki) to host your documentation</li> <li>Extensible framework</li> <li><a href="./doxia-sitetools/">Site Tools extension</a> for site or document rendering</li> <li><a href="./doxia-tools/">Additional Tools</a> like <a href="./doxia-tools/doxia-converter/index.html">Doxia Converter</a></li></ul></section><section> <h3><a name="Doxia_Reference_Pages"></a>Doxia Reference Pages</h3> <p>See <a href="./references/index.html">Doxia Markup Languages References</a> page for a listing of all supported markups for each format.</p></section></section> </main> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row-fluid"> <p>© 2005–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a> </p> </div> </div> </footer> <script> if(anchors) { anchors.add(); } </script> </body> </html>

CINXE.COM

Doxia – Introduction