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

docker: add highlight.js to Noble v4 environment #95

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

julioest
Copy link

@julioest julioest commented Feb 28, 2025

  • create Docker image v4 based on Ubuntu Noble (24.04)
  • add highlight.js 9.18.3 via npm
  • update image name to cppalliance/boost_superproject_build:24.04-v4

CC @sdarwin

@julioest julioest marked this pull request as ready for review February 28, 2025 04:56
@sdarwin
Copy link
Contributor

sdarwin commented Feb 28, 2025

cppalliance/boost_superproject_build:24.04-v4 uploaded to Docker Hub. The image exists and may be used in testing.

It raises a question though: does asciidoctor need a (local) copy of the node package highlight.js to process files? Will it use the local highlight.js?

Maybe this docker image will turn out to be unnecessary. If so, we can stay on 24.04-v3.

@julioest
Copy link
Author

Not sure if this answers your question, but it seems that we can decide on whether we need it locally vs CDN (default).

https://docs.asciidoctor.org/asciidoctor/latest/syntax-highlighting/highlightjs/#activate-highlight-js

By default, Asciidoctor will link to the highlight.js library and stylesheet hosted on cdnjs. The version of the highlight.js library Asciidoctor loads from the CDN only includes support for languages in the common language bundle (apache, bash, coffeescript, cpp, cs, css, diff, http, ini, java, javascript, json, makefile, markdown, nginx, objectivec, perl, php, properties, python, ruby, shell, sql, xml, and yaml).

If we wanted to use a personal copy of a custom highlight.js build:
https://docs.asciidoctor.org/asciidoctor/latest/syntax-highlighting/highlightjs/#use-a-custom-highlight-js-library

@sdarwin
Copy link
Contributor

sdarwin commented Feb 28, 2025

There are distinct topics:

  1. building the docs (that happens in release-tools)

  2. Consuming the docs (after they have already been uploaded to boost.io, and now visitors see them)

Perhaps "personal copy of a custom highlight.js build" is focused more on the second point, which is about viewing the docs.

In terms of the first part (building the docs), this is the question: if anything is needed at all? Maybe asciidoctor has built-in support for generating highlights so npm packages aren't needed.

If that's uncertain we can test with 24.04-v4 and then go back to 24.04-v3, comparing them.

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

Successfully merging this pull request may close these issues.

2 participants