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
The Philosophy Goal Implementation links all point to One-to-One #12197
Comments
Hello! Thanks for reporting this. This seems a nontrivial bug from esdoc since it generates the heading 'names' simply from their own text, and since the texts are identical, this ends up happening. Maybe we can perform a manual fix... |
Awesome. I suggest you see how I've done some documentation transforms and write your own transform to update the duplicate heading links to something else (perhaps adding suffixes such as |
Found the offending code in the publish html plugin, but not sure how much work it is to swap it out. https://github.com/esdoc/esdoc-plugins/blob/master/esdoc-publish-html-plugin/src/Builder/util.js#L65 const renderer = new marked.Renderer();
renderer.heading = function (text, level) {
const id = escapeURLHash(text);
return `<h${level} id=${id}>${text}</h${level}>`;
}; |
Oh, you forgot to specify |
Issue Description
What was unclear/insufficient/not covered in the documentation
The Philosophy, Goal, Implementation links under One-to-Many and Many-to-Many all point to the headings with the same names under One-to-One.
If possible: Provide some suggestion on how we can enhance the docs
Fix the links to point to their corresponding headings.
Additional context
Issue Template Checklist
Is this issue dialect-specific?
Would you be willing to resolve this issue by submitting a Pull Request?
The text was updated successfully, but these errors were encountered: