-
Notifications
You must be signed in to change notification settings - Fork 16
fixed broken anchor link #93
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
Conversation
@dlebauer Let me know if any further changes are required! |
Hi @divine7022 thanks for this change. I'm trying to understand this change (and also the 'onbroken*' parameters). Why do we want to ignore these and what is the behavior when a link is broken? Would it be better to throw an error and fix links? Or throw a warning and let the build pass? |
@dlebauer, thanks for your feedback sir! The reason for using onBrokenAnchors: "ignore" is to allow the build to pass even if there are missing or broken anchor links. There are two approches to fix it:
I’m currently working on improving this to ensure a more efficient and reliable solution. Just a minute! |
changes in docusaurus.config.js (onBrokenAnchors: "ignore") is no more need, because i fixed directly in gsoc_ideas.mdx which was casing an broken anchor link problem.
@dlebauer Hello sir,
click here to reviewLet me know if any further modifications are needed. |
Awesome, thanks! But now it looks like there is a build issue? https://github.com/PecanProject/PecanProject.github.io/actions/runs/13444057397/job/37565167053#step:3:1 I just re-ran the build. Thanks for fixing the header levels as well. |
Though I'm still not clear why either these are required / or why we would get warnings. Docs said that these links will be automatically generated if not provided. https://docusaurus.io/docs/next/markdown-features/toc#heading-ids I also want to make sure that we are solving the right problem. If this is required for all (or any) new pages, could you please update the contributing section of the README with info about using these links? - mostly what pages and header levels require them and how they should be formatted. It can be brief with a link to the docusaurus documentation (above). 🙏 |
@dlebauer hello sir, let me clarify why we need
Why is this needed?
I'll also update the contributing section of the README with this information and a reference to the Docusaurus documentation. |
Got it - now it makes sense, as a way of preventing broken links if headers check. Thanks.
Message ID: ***@***.***>
|
@dlebauer Glad it makes sense! |
@dlebauer |
@dlebauer , This PR fixes the |
@dlebauer
Fixed: #92
This PR addresses the issue of broken anchor links in the /gsoc_ideas page that were causing build warnings during
yarn build
.