Logo
Sign in

Apache Doxia is a content generation framework for creating static and dynamic documentation. It supports multiple lightweight markup languages and is used extensively by Apache Maven to render project documentation. Doxia enables developers to produce readable and maintainable content across various formats.

Vendor

Vendor

The Apache Software Foundation

Company Website

Company Website

architecture.png
doxia-deps.png
Product details

Apache Maven Doxia

Apache Doxia is a content generation framework developed in Java, designed to produce both static and dynamic documentation. It supports a wide range of lightweight markup languages and is extensively used by Apache Maven to render project documentation. Doxia enables developers to write documentation in simple syntaxes and convert it into various output formats, making it ideal for web publishing and integration into content management systems.

Features

  • Supports multiple markup formats including APT, Markdown, Confluence, DocBook, LaTeX, RTF, TWiki, XDoc, and XHTML
  • Developed in Java with extensible architecture
  • Macro support for dynamic content generation
  • Site Tools extension for rendering documents and websites
  • Doxia Converter for format transformation
  • Easy-to-learn syntax for supported markup languages
  • Sink API for generic markup handling
  • Parser interface for source-to-output conversion
  • Velocity template integration for site customization

Capabilities

  • Generates static websites and dynamic documentation from lightweight markup
  • Integrates with Maven Site Plugin for automated site rendering
  • Parses source documents and populates structured output via Sink objects
  • Supports modular development through Doxia modules for each markup language
  • Enables site decoration and layout customization via site.xml
  • Facilitates error handling and debugging with ParseException and line tracking

Benefits

  • Simplifies documentation creation for developers and project maintainers
  • Promotes consistency and readability across documentation formats
  • Reduces infrastructure needs for hosting documentation
  • Enhances maintainability through modular and extensible design
  • Enables seamless integration into build and deployment pipelines
  • Backed by the Apache Software Foundation for long-term stability