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.
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.