Fix rendering of the build options table in BuildOptions.md - #14323
Open
koppor wants to merge 1 commit into
Open
Fix rendering of the build options table in BuildOptions.md#14323koppor wants to merge 1 commit into
koppor wants to merge 1 commit into
Conversation
The table between the `<!-- BEGIN: build-options-table -->` and `<!-- END: build-options-table -->` markers was rendered as a plain paragraph on graalvm.org (see https://www.graalvm.org/latest/reference-manual/native-image/overview/Options/). kramdown, the Markdown parser used by the website, only recognizes a table that starts after a block boundary. Since the table directly followed the HTML comment marker without a blank line in between, the whole table was parsed as one paragraph. Add blank lines between the markers and the table, and make `mx update-build-options-table` emit them so that regenerating the table does not reintroduce the problem. The verification in `verify_build_options_table` strips the extracted content, so it is not affected by the additional blank lines. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QCkkfwM4p6DgUYzCXio6dj
oracle-contributor-agreement
Bot
added
the
OCA Verified
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The build options table on https://www.graalvm.org/latest/reference-manual/native-image/overview/Options/ is currently rendered as a single paragraph of raw
|-separated text instead of a table (the---------separator row even shows up as em-dashes).Cause
kramdown, the Markdown parser used by the GraalVM website, only recognizes a table that starts after a block boundary (
after_block_boundary?in kramdown's table parser). InBuildOptions.md, the table directly follows the<!-- BEGIN: build-options-table -->HTML comment without a blank line, so kramdown treats the whole table as a paragraph.Verified locally with kramdown 2.5.2 (both the default and the GFM parser): the current file yields one
<table>on the page (the system properties table), the fixed file yields two.Fix
docs/reference-manual/native-image/BuildOptions.md: add a blank line after theBEGINmarker and before theENDmarker.substratevm/mx.substratevm/mx_substratevm_docs.py: makemx update-build-options-tableemit those blank lines so that regenerating the table does not reintroduce the problem.verify_build_options_tablestrips the content between the markers before comparing, so the check is unaffected.馃 Generated with Claude Code
https://claude.ai/code/session_01QCkkfwM4p6DgUYzCXio6dj