How owenh000/asciidoctor-multipage works
Main Components
• Asciidoctor Integration: Represent how the extension hooks into Asciidoctor’s conversion engine. Show the converter module (found in lib/asciidoctor-multipage) that overrides or extends the standard HTML converter.
• Configuration & Attribute Parser: Include a component that handles the parsing of document attributes such as multipage-level and desc for controlling behavior during conversion.
• External Dependencies & Integration: Display the dependency on Asciidoctor and note the integration with external systems like Travis CI (as seen in .travis.yml) and GitHub workflows (in the .github directory) for continuous integration and deployment.
Relationships and Interactions
• Converter Engine receiving input (an Asciidoctor file) from the user or CI process and passing it to the Asciidoctor integration layer.
• That the output of the core conversion is generated HTML files (multipage output) which are also validated by the Test Suite.
• Integration with external dependencies (e.g., Asciidoctor library) that are part of the conversion pipeline.
Architectural Patterns and Design Principles
• Plugin/Extension Architecture: Emphasize that the project adheres to a plugin model where it extends a base converter in Asciidoctor.
• Separation of Concerns: Clearly separate the CLI module, core conversion logic, configuration parsing, and testing components.
• Test-Driven Development: Highlight the role of the test suite in ensuring that external changes (or Asciidoctor updates) do not break the conversion functionality.