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(docs): upgrade to Docusaurus v3 #1558

Merged
merged 1 commit into from
Nov 9, 2024
Merged

chore(docs): upgrade to Docusaurus v3 #1558

merged 1 commit into from
Nov 9, 2024

Conversation

shadaj
Copy link
Member

@shadaj shadaj commented Nov 8, 2024

Main breaking change is MDX parsing, which trips up on unescaped < in the generated docs, so we have to adjust the generator logic.

Copy link

cloudflare-workers-and-pages bot commented Nov 8, 2024

Deploying hydroflow with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3691eee
Status: ✅  Deploy successful!
Preview URL: https://f2450a26.hydroflow.pages.dev
Branch Preview URL: https://pr1558.hydroflow.pages.dev

View logs

@shadaj shadaj requested a review from MingweiSamuel November 8, 2024 20:39
@shadaj shadaj force-pushed the pr1558 branch 2 times, most recently from 6ac04d5 to 45187dc Compare November 8, 2024 20:48
if (grammar == rustLanguage) {
text = text.split("\n").filter(line => !line.startsWith("# ")).join("\n");
PrismObject.hooks.add("after-tokenize", function(env) {
if (env.language == "rust") {
Copy link
Member

Choose a reason for hiding this comment

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

Should this be === Prism.languages.rust? (should at least be triple equal for style)

Copy link
Member Author

Choose a reason for hiding this comment

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

Not in this case, it's just a string identifier rather than an object.

"{}",
read_string
.split("<!--")
.map(|t| t.replace("<", "\\<"))
Copy link
Member

Choose a reason for hiding this comment

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

\\< not &lt?

Copy link
Member Author

Choose a reason for hiding this comment

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

Either works, picked \\ to minimize the difference from the previously generated docs.

Main breaking change is MDX parsing, which trips up on unescaped `<` in the generated docs, so we have to adjust the generator logic.
@shadaj shadaj merged commit c58f13c into main Nov 9, 2024
27 checks passed
@shadaj shadaj deleted the pr1558 branch November 9, 2024 00:09
@MingweiSamuel MingweiSamuel added the documentation Improvements or additions to documentation label Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants