Skip to content

docs: remove legacy Kramdown topic-type IAL markers (openvox 8.x)#312

Merged
tuxmea merged 3 commits into
OpenVoxProject:masterfrom
miharp:docs/issue-274-kramdown-ial
Jun 8, 2026
Merged

docs: remove legacy Kramdown topic-type IAL markers (openvox 8.x)#312
tuxmea merged 3 commits into
OpenVoxProject:masterfrom
miharp:docs/issue-274-kramdown-ial

Conversation

@miharp

@miharp miharp commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Removes 143 legacy Kramdown topic-type IAL markers ({:.concept}, {:.section}, {:.task}, {:.reference}, {:.example}) from the openvox 8.x docs. They're leftovers from the old DITA-style Puppet docs build.

On the deployed site, Kramdown attaches each marker as a CSS class to the following heading (e.g. <h2 class="concept">), but the jekyll-vitepress-theme has no styling for those classes — verified in both the source SCSS and the built CSS bundles — so they're completely inert dead cruft.

Changes

  • Remove all 143 standalone {:.<type>} IAL lines across 17 files in docs/_openvox_8x/
  • Where a marker was orphaned between two blank lines, collapse the resulting duplicate blank; all other blank lines are left untouched
  • Preserved lookalike IALs that are not dead markers: {:class="resolution"} (a real styling class, 6×) and {::fact}-style template/fact examples (19×)

Pure deletions (144 lines: 143 markers + 1 collapsed orphan blank), no reformatting.

Verification

  • jekyll build passes
  • No {:.…} markers render as literal text in the built HTML (they never did on the deployed site — only in GitHub's CommonMark preview)
  • The inert class="concept"/class="section" attributes are gone from the rendered headings, which still render with their ids intact

Closes #274

@miharp miharp requested a review from a team as a code owner June 8, 2026 14:41
The openvox 8.x docs carried 143 standalone Kramdown topic-type IAL
markers ({:.concept}, {:.section}, {:.task}, {:.reference}, {:.example})
inherited from the old DITA-style Puppet docs build. Kramdown attaches
them as CSS classes to the following heading, but the jekyll-vitepress
theme has no styling for those classes, so they are inert dead cruft.

Remove all of them across 17 files. Lookalike IALs are preserved:
{:class="resolution"} (a real styling class) and {::fact}-style
template/fact examples. Where a marker was orphaned between two blank
lines, the duplicate blank is collapsed; other blank lines are left
untouched.

Verified: jekyll build passes, headings render identically (with their
ids intact), and no markers render as literal text.

Closes OpenVoxProject#274

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp force-pushed the docs/issue-274-kramdown-ial branch from bfe7459 to 4047532 Compare June 8, 2026 17:55
@tuxmea tuxmea enabled auto-merge June 8, 2026 19:39
@tuxmea tuxmea merged commit 3eaae8e into OpenVoxProject:master Jun 8, 2026
5 checks passed
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.

Remove legacy Kramdown topic-type IAL markers ({:.concept}, {:.section}, …) rendering as literal text

2 participants