boostorg / boostorg/website-v2-docs

Better callout rendering

Open Beginner friendly
#699 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
14
Forks
60
Avg merge
12h 47m
Merged PRs (30d)
14

Description

Here is how callouts get rendered in Boost.Capy, which uses the look from this repo:
https://develop.capy.cpp.al/capy/2.cpp20-coroutines/2c.machinery.html#_the_compiler_transformation

The callout names in the source code render as text ("open paren" followed by number followed by "close paren"). This makes it look like a syntax error in the source code. Other Antora generated pages, render nice circles, like this one: https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/

Can this be changed in this repo also?

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the callouts in the linked Boost.Capy page with the circular callouts shown in the Asciidoctor documentation. Then locate this repository’s callout-rendering configuration or templates and identify where the source-text labels are produced. Done means generated documentation displays callout names as circles rather than parenthesized text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.