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
TOC links in README are all broken on NPM #707
Comments
Thank you for the report. Re: breaking it up, as per #475 (comment) , this was rejected. |
🎉 This issue has been resolved in version 37.9.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Thanks for the gitdown fix, @gajus! The links now appear to be generally working, but as a result apparently of the document being too large, it seems npmjs.com has truncated the contents, so that rules after What do you think of our using some document generator which may allow for the advantages of smaller loads and less overwhelming data showing per page, but with a search feature which allows searching for a string of text across all the documents? I assume such tools may exist. |
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | devDependencies | patch | [`37.9.5` -> `37.9.7`](https://renovatebot.com/diffs/npm/eslint-plugin-jsdoc/37.9.5/37.9.7) | --- ### Release Notes <details> <summary>gajus/eslint-plugin-jsdoc</summary> ### [`v37.9.7`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v37.9.7) [Compare Source](gajus/eslint-plugin-jsdoc@v37.9.6...v37.9.7) ##### Bug Fixes - **`no-undefined-types`:** support `unknown` and `const`; fixes [#​846](gajus/eslint-plugin-jsdoc#846) ([b5b3e17](gajus/eslint-plugin-jsdoc@b5b3e17)) ### [`v37.9.6`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v37.9.6) [Compare Source](gajus/eslint-plugin-jsdoc@v37.9.5...v37.9.6) ##### Bug Fixes - update devDeps, including gitdown to fix README URLs; fixes [#​707](gajus/eslint-plugin-jsdoc#707) ([2d69c70](gajus/eslint-plugin-jsdoc@2d69c70)) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1196 Reviewed-by: 6543 <6543@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
When viewing the NPM page of this package, the table of contents in the README file is useless, none of the links will bring you to the target.
Example:
The page contains a link
https://www.npmjs.com/package/eslint-plugin-jsdoc#eslint-plugin-jsdoc-settings
but the target element is<a id="user-content-settings" class="anchor" href="#settings" aria-hidden="true">
BTW, did you ever considered breaking this monster into smaller pieces? :)
The text was updated successfully, but these errors were encountered: