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

chore: fix docs build #6635

Merged
merged 4 commits into from
Dec 27, 2021
Merged

Conversation

jakovljevic-mladen
Copy link
Member

@jakovljevic-mladen jakovljevic-mladen commented Oct 8, 2021

Description:
For some reason, remark-html with version 13 doesn't generate code examples and some guide files correctly. I tried increasing remark version to 12, 13 and 15, but it didn't work for multiple reasons, so I had to lower the remark-html from version 13 to version 12.

For example, this is how a code example looked like (without fix from this PR):

image

And this is the blank page from /api route:
image

This PR fixes these issues.

Edit: please check updated description.

Related issue (if exists):
None

@jakovljevic-mladen
Copy link
Member Author

I managed to upgrade remark version to v12 and to keep remark-html at v13. To do this, I had to copy some stuff from Angular.

Related: angular/angular#24000 and angular/angular#41721

Copy link
Member

@niklas-wortmann niklas-wortmann left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -118,9 +118,8 @@
"lunr": "^2.1.0",
"mkdirp": "^0.5.1",
"protractor": "~7.0.0",
"rehype": "^10.0.0",
Copy link
Member Author

Choose a reason for hiding this comment

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

This was removed in #6470, but was reintroduced with #6566, most probably by the wrong conflict resolve. I removed it once again.

@jakovljevic-mladen
Copy link
Member Author

@niklas-wortmann, rebased against master and force pushed.

@benlesh benlesh merged commit 5835116 into ReactiveX:master Dec 27, 2021
@jakovljevic-mladen jakovljevic-mladen deleted the fix_building_docs branch December 27, 2021 20:57
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.

4 participants