SitecoreDXG Documention
Overview
Getting Started
Downloads
GitHub Repository
Search…
SitecoreDXG: The Documentation Experience Generator
Overview
SitecoreDXG: The Documentation Experience Generator
Comparison with SitecoreUML
CI/CD Integration
Helix Dependency Validation
Getting Started
Compatibility and System Requirements
Installing SitecoreDXG
Upgrading and Downgrading
Downloads
Using SitecoreDXG
Architecture
Architecture Overview
Roles
Components
Plugins
Middlemen
Understanding the Default RabbitMQ Middleman and Trigger
How To
CI/CD Integration
Creating a Custom Trigger
Executing Documentation Generation
Executing Meta-Data JSON Generation
Slack and Microsoft Teams Integration
Creating a Custom Completion Handler
Creating a Custom Middleman
Viewing Helix Validation Errors
About the Generated Documentation
Overview
Models
Views
Diagrams
Samples
Powered By
GitBook
Executing Documentation Generation
In order to generate documentation, you need to call the
generateDocumentation
function of the
generation
module.
The function has the following syntax:
1
generation.generateDocumentation(
2
Object data, // the parsed JSON data response received from the serializer
3
Fn successCallback, // callback to be executed on successful generation
4
Fn errorCallback, // callback to be executed on generation error
5
);
Copied!
Following this syntax, the below can be used to execute documentation generation:
1
generation
.
generateDocumentation
(
2
data
,
3
function
(
targetArchiveFilePath
,
targetArchiveFileName
,
targetFolderPath
,
targetHtmlDocFolderPath
,
targetMdjFilePath
)
{
4
...
your logic to run on success
...
5
},
6
function
(
error
)
{
7
...
your logic to run on error
...
8
}
9
);
Copied!
How To - Previous
Creating a Custom Trigger
Next
Executing Meta-Data JSON Generation
Last modified
3yr ago
Copy link