Class: Lutaml::UmlRepository::Exporters::MarkdownExporter

Inherits:
BaseExporter
  • Object
show all
Defined in:
lib/lutaml/uml_repository/exporters/markdown_exporter.rb

Overview

Export UML repository to Markdown documentation.

Generates a complete documentation site in Markdown format with:

  • Index page with package tree

  • Package pages with class listings

  • Class pages with attributes and associations

  • Diagram references

Examples:

Basic export

exporter = MarkdownExporter.new(repository)
exporter.export("docs/")

Export specific package

exporter.export("docs/", package: "ModelRoot::i-UR::urf")

Instance Attribute Summary

Attributes inherited from BaseExporter

#repository

Instance Method Summary collapse

Methods inherited from BaseExporter

#initialize

Constructor Details

This class inherits a constructor from Lutaml::UmlRepository::Exporters::BaseExporter

Instance Method Details

#export(output_path, options = {}) ⇒ void

This method returns an undefined value.

Export repository to Markdown documentation.

Parameters:

  • output_path (String) —

    Path to the output directory

  • options (Hash) (defaults to: {}) —

    Export options

Options Hash (options):

  • :package (String) —

    Filter by package path

  • :recursive (Boolean) — default: true —

    Include nested packages

  • :title (String) — default: "UML Model Documentation" —

    Site title



32
33
34
35
36
37
38
39
40
 
# File 'lib/lutaml/uml_repository/exporters/markdown_exporter.rb', line 32

def export(output_path, options = {})
  @output_dir = output_path
  @options = options

  create_directory_structure
  generate_index_page
  generate_package_pages
  generate_class_pages
end