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

Update Docusaurus 3 #111

Merged
merged 12 commits into from
Aug 6, 2024
Merged

Update Docusaurus 3 #111

merged 12 commits into from
Aug 6, 2024

Conversation

Vrixyz
Copy link
Contributor

@Vrixyz Vrixyz commented Jul 5, 2024

Builds on #110

docusaurus 2.4 docusaurus 3
docusaurus 2.4 Screenshot 2024-07-05 at 09-58-37 Getting started Rapier

@Vrixyz Vrixyz requested a review from sebcrozet July 19, 2024 14:56
@Vrixyz Vrixyz marked this pull request as ready for review July 22, 2024 09:42
deps remark-math and rehype-katex updated
@Vrixyz
Copy link
Contributor Author

Vrixyz commented Aug 2, 2024

(not really related to this PR, but) on my linux, the inject file script seems to have a bug which omits the last \n, which makes yarn build fail ; I'll look into it, this might be the source of failure for CI

Comment on lines +13 to +22
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run injection script locally
run: find docs/user_guides/templates/ -type f -print0 | OUTPUT_FOLDER=docs/user_guides/templates_injected xargs -0 ./inject_code_in_user_guides.sh
- name: User guides generation
run: ./generate_user_guides.sh
- name: yarn install
run: corepack enable && yarn
- name: yarn build
run: PUBLISH_MODE=1 yarn build
Copy link
Contributor Author

Choose a reason for hiding this comment

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

yarn build tested on CI is great, it currently outputs some warning concerning links, which might be related to #41

A good follow up Pull Request would be to eliminate these warnings. From my testing these warnings don´t indicate regressions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changes have been made to this script to make it more cross platform friendly. I tested on mac, windows, linux.

Comment on lines +4 to +10
if [ gsed -v ]; then
gsed=gsed
else
# Hopefully installed sed is the gnu one.
# note: aliases work poorly with xargs.
gsed=sed
fi
Copy link
Contributor Author

Choose a reason for hiding this comment

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

using gsed is not trivial on linux actually, so this "hack" allows for better cross platform tooling.

Copy link
Member

@sebcrozet sebcrozet left a comment

Choose a reason for hiding this comment

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

Looking fantastic, thank you!

@Vrixyz Vrixyz merged commit b215e48 into dimforge:master Aug 6, 2024
4 checks passed
@Vrixyz Vrixyz mentioned this pull request Aug 6, 2024
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.

2 participants