Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Asciidoctor renders README.adoc and Release Notes #1302

Open
vinniefalco opened this issue Oct 1, 2024 · 0 comments
Open

Asciidoctor renders README.adoc and Release Notes #1302

vinniefalco opened this issue Oct 1, 2024 · 0 comments

Comments

@vinniefalco
Copy link
Member

vinniefalco commented Oct 1, 2024

The Python code should render README.adoc and Release Notes using asciidoctor's "embedded" mode

Pass "-e" or "--embedded" command line option when invoking asciidoctor to render:
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#options

README.adoc is shown on the Library page and Release Notes are shown on the Release page. Examples:

Bottom panel here:
https://www.stage.boost.cppalliance.org/libraries/beast/boost-1-86-0/

Bottom panel here:
https://www.stage.boost.cppalliance.org/releases/boost-1-86-0/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant