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.

Why do I get a message asking me to authenticate to view content from a public repository?

GitHub applies a limit rate to unauthenticated requests made to retrieve content. It is possible that such rate limit may be reached prompting you to authenticate even to access public repositories. Once authenticated the user should be able to see the requested data.

Why does the app need “write” permission for the OAuth scope when allowing the Confluence instance for Github?

The app technically does not require “write“ permissions but unfortunately the GitHub API does not provide a read-only OAuth scope for public and/or private repos which is what our app needs and we are forced to use the “repo“ scope. Including GitHub documentation on Scopes for OAuth Apps as reference.

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 resize images in my files so they don’t take the full width and height?

You can add custom sizes to images in Markdown using HTML. While Markdown is great for formatted text, it doesn't natively support resizing images. But with the img tag, you can easily control image dimensions.

For example:

<img src="image.jpg" width="400" height="400"/>              

Can I customize the file layout when exporting via PDF (e.g. image size)?

Yes, you can customize the layout for PDF exports, including the image size, by modifying the Confluence PDF stylesheet. For example, adding the following CSS rule to the PDF stylesheet will ensure that the images in the exported file are displayed at the same size:

img { width: 85%; height: 85%; }

For more details on customizing PDF exports, you can refer to the official Atlassian documentation: Customize Exports to PDF.

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://github.com/your-org/yor-repo/blob/bugfix/issue-123/markdown/test-basic.md to https://github.com/your-org/yor-repo/blob/bugfix%2Fissue-123/markdown/test-basic.md

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>