docToolchain / docToolchain/docToolchain

Confluence page does not render code callouts properly

Open
#315 11 comments 1 reaction 0 assignees View on GitHub
Dominant language
Groovy
Stars
864
Forks
240
Avg merge
2m
Merged PRs (30d)
2

Description

One of my favorite features of asciidoctor is to be able to add callouts to code blocks, like this:

[source,yaml]
.Add cli to your docker-compose.yml
----
cli:
image: cli:v2.0.5
entrypoint: "tail" <1>
command: ["-f","/dev/null"] <1>
----
<1> This will override the default entrypoint `cli.sh` and just hang with a `tail -f /dev/null` to prevent docker from exiting. See link:../infrastructure/cli-docker.html[Article on cli] for details.

However Confluence does not seem to support this in their own code blocks.

When asciidoc2confluence rewrites the generated HTML to translate them to Confluence code blocks, the resulting callouts in the code block show as inlined HTML in the code, something like this:

cli:
image: cli:v2.0.5
entrypoint: "tail" (1)
command: ["-f","/dev/null"] (1)

Is it possible to just disable rewriting the code block, so that it is not recognized by confluence as a code block, and thus not to suffer from their limitations?

**To Reproduce**

1. Add a code block with callouts to your asciidoctor file
2. publishToConluence
4. See resulting Confluence page

**Expected behavior**
That the uploaded confluence page shows callouts like a normal asciidoctor rendered HTML page.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.