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

fix: parse project changelogs with remark #1342

Merged
merged 4 commits into from
Dec 12, 2024
Merged

Conversation

barjin
Copy link
Contributor

@barjin barjin commented Dec 11, 2024

This PR adds actual parsing of the Markdown content instead of using RegExp-based transformations. This mitigates the problems with mismatched token delimiters (nested Markdown links etc.).

Fixes the documentation build in https://github.com/apify/apify-client-js (which in turn unblocks the releases there).

related to facebook/docusaurus#10739

@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Dec 11, 2024
@barjin barjin self-assigned this Dec 11, 2024
@barjin barjin requested review from B4nan and janbuchar December 11, 2024 14:01
@github-actions github-actions bot added this to the 104th sprint - Tooling team milestone Dec 11, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Dec 11, 2024
Copy link
Member

@B4nan B4nan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll trust you on this one, if the build works, i guess its fine

apify-docs-theme/src/markdown.js Show resolved Hide resolved
@barjin
Copy link
Contributor Author

barjin commented Dec 11, 2024

With @janbuchar we discussed using the remark's visitor pattern instead of the current recursion, but that should be both quick and quite unintrusive with the current impl.

@barjin barjin merged commit 49bd13d into master Dec 12, 2024
8 checks passed
@barjin barjin deleted the fix/remark-changelog branch December 12, 2024 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants