FAQ

Is it possible to export Git assets to PDF or Word?

Yes, you can export Git assets (including files and other content) as part of a PDF or Word export of your Confluence page.

Do you support advanced links embedded in an AsciiDoc?

Advanced links such as {asciidoc-dir}/../../shared/versions/stack/{source_branch}.adoc are currently not supported and we display in the included file.

Why are images within a Markdown or AsciiDoc not rendered?

When including images in AsciiDoc or Markdown files, you should be able to include the images using absolute paths instead of relative paths:

AsciiDoc

=== Picture 1 Block

image::/images/Example.png[]

=== Picture 2 Inline

image:/images/Example.png[]

Markdown

![Alt text](src/images/image.png)

How can I include the C4-PlantUML library in my .puml files so the app renders them?

You can use !include <C4/C4_Container> for including the C4-PlantUML library.

Example:

@startuml
!include <C4/C4_Container>

Person(personAlias, "Label", "Optional Description")
Container(containerAlias, "Label", "Technology", "Optional Description")
System(systemAlias, "Label", "Optional Description")

System_Ext(extSystemAlias, "Label", "Optional Description")

Rel(personAlias, containerAlias, "Label", "Optional Technology")

Rel_U(systemAlias, extSystemAlias, "Label", "Optional Technology")
@enduml

Reference: https://plantuml.com/stdlib#062f75176513a666

Branches with Slashes

Branches with slashes in their name (eg bugfix/issue-123, feature/abc) are not supported at the moment.

As a work around, replace the slash of the branch name in the URL with %2F, for example the bugfix/issue-123 branch URL https://gitlab.com/your-repo/test-files/-/blob/bugfix/issue-123/src/test.txt?ref_type=heads to https://gitlab.com/your-repo/test-files/-/blob/bugfix%2Fissue-123/src/test.txt?ref_type=heads

Let us know your use case here if you require support for slashes in branch names.

How can I include the PlantUML Standard library?

To use the official Standard Library for PlantUML, you can use the following syntax in the PlantUML file:

!include <awslib/AWSCommon>
!include <awslib/Groups/all>
!include <awslib/ApplicationIntegration/MQ>
!include <awslib/Database/DocumentDB>
!include <awslib/Database/RDS>
!include <awslib/Containers/Containers>
!include <awslib/Storage/SimpleStorageService>
!include <awslib/Storage/SimpleStorageServiceGlacier>
!include <awslib/ApplicationIntegration/APIGateway>
!include <awslib/SecurityIdentityCompliance/Cognito>
!include <awslib/Database/DocumentDB>
!include <awslib/Database/RDS>
!include <awslib/Compute/Lambda>
!include <awslib/InternetOfThings/IoTThingGeneric>