Markdown¶
Overview¶
The ALFA Markdown Exporter generates Markdown for each of the definitions in the ALFA model. Unlike the HTML Exporter generating a web application, the Markdown is static content.
The content generated can be hosted as a static website.
Refer to the site below for an example of a generated Markdown site.
https://schemarise.github.io/demo-alfa-with-fire-json-model/
Executing Markdown Exporter¶
Use the following commands:
alfa -exporters markdown -output target/docs alfamodels/
Or using the ALFA Maven Plugin CLI.
mvn "com.schemarise.alfa.utils:alfa-maven-plugin:3.5.11:cli" "-Dalfa.exporters=markdown" "-Dalfa.output=target/docs" "-Dalfa.sourcepath=alfamodels"