patternfly / patternfly/patternfly-org

[docs-framework] Rewrite custom remark plugins & Fix private API dependencies

Open
#4,961 0 comments 0 reactions 1 assignee View on GitHub

@nicolethoen is already working on this.

Since Mar 12, 2026.

PF Team
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

1a. Rewrite remove-comments.js (Effort: Small)

Currently 22 lines, uses this.Parser.prototype.blockTokenizers + eat() to strip HTML
comments
Migration: Likely redundant — parseMD.js already does remove(tree, 'comment') later in the
pipeline. May be able to just delete it.

1b. Rewrite auto-link-url.js (Effort: Small-Medium)

Currently 33 lines, re-adds https://... autolink support that remark-mdx strips
Migration: Check if remark-mdx v3 still strips autolinks. If not, this plugin is
unnecessary. If still needed, convert to an MDAST tree transform or write a micromark
extension.

2a. Fix mdx-hast-to-jsx.js (Effort: Medium)

Uses remark-mdx/lib/serialize/ private internals for serializeTags() and
serializeMdxExpression()
Uses hast-to-hyperscript and @mdx-js/util (v1) which may not exist in v3
Uses this.Compiler pattern (removed in unified v11)
Need to find public API replacements or inline the functionality

2b. Fix mdx-ast-to-mdx-hast.js (Effort: Small-Medium)

Uses mdast-util-to-hast/lib/all private import
Handler API may differ in mdast-util-to-hast v13


Jira Issue: PF-3695

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.