FAQ
Are there any file size limits?
Yes, see Technical Details .
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.
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.
Why are images within a Markdown or AsciiDoc not rendered?
If images in your Markdown or AsciiDoc files aren’t rendering, it’s often due to the use of relative paths that can’t be resolved in the current context.
To ensure images are rendered correctly:
Use absolute paths relative to the repository root when possible.
Make sure the image file exists and is accessible at the specified path.
AsciiDoc
=== Picture 1 Block
image::/images/Example.png[]
=== Picture 2 Inline
image:/images/Example.png[]Markdown
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")
@endumlReference: https://plantuml.com/stdlib#062f75176513a666
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>Why don’t my embedded images load correctly in Scroll Viewport when using relative paths in an AsciiDoc file?
When using Scroll Viewport with images hosted in Git, relative image paths can trigger an authentication request, preventing them from loading properly.
To resolve this, use a full URL that references the raw file URL directly. This allows Scroll Viewport to fetch the image without requiring authentication.
⚠️ Note: This approach only works if the repository is publicly accessible. If the repository is private, authentication may still be required and the images will not be visible.
Example Usage in AsciiDoc:
image::https://github.com/yourInstance/blob/main/image.png?raw=true[title="image"]How to Get the Raw File URL?
To obtain the raw URL of an image file in GitHub Cloud:
Navigate to the image file in your repository.
Right click on the image and choose
Copy Image Address
What dialect of Markdown is supported?
Our app supports CommonMark, the formal specification for modern Markdown.
In addition to CommonMark’s core features, we enable a focused set of extensions that provide functionality users commonly expect. Some of these extensions overlap with capabilities found in GitHub-Flavored Markdown (GFM), but we do not implement the full GFM specification.
Below is the complete list of supported extensions, each with a short example demonstrating how it works.
1. Tables (TableExtension)
Supports pipe-style tables and column alignment.
Example:
| Name | Role | Location |
|-------|-----------|----------|
| Alice | Developer | Zurich |
| Bob | Designer | London |2. Autolinks (AutolinkExtension)
Automatically turns URLs and email addresses into links.
Example:
https://example.com
user@example.com3. Heading Anchor IDs (HeadingAnchorExtension)
Automatically generates stable id attributes for headings.
This allows users to link to specific sections within a document.
Example:
# Overview
See the Scope section below:
[Go to Scope](#scope)
---
## Scope
This is the Scope section content.4. Strikethrough (StrikethroughExtension)
Adds support for strikethrough syntax~~text~~ .
Example:
This text has ~~strikethrough~~ formatting.