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

docs: add links to top with jump2header #723

Closed
wants to merge 1 commit into from
Closed

docs: add links to top with jump2header #723

wants to merge 1 commit into from

Conversation

strdr4605
Copy link

Added link to for so it will be easier to navigate in README.

Demo.

Generated with:

jump2header -slug toc -position end -emoji 2 --start Features -max-level 2

with small manual adjustments.

If you don't like the PR but interested in links to top see jump2header for more options.

Copy link
Collaborator

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR and apologies for the delay.

I think this is useful, however it will be superseded by the fix to #848 and so is not necessary.

@@ -58,6 +60,8 @@ TSDX comes with the "battery-pack included" and is part of a complete TypeScript
- Jest test runner setup with sensible defaults via `tsdx test`
- Zero-config, single dependency

[🔝](#toc)<!-- Link generated with jump2header -->
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
[🔝](#toc)<!-- Link generated with jump2header -->
[🔝 Back to Top 🔝](#toc)<!-- Link generated with jump2header -->

Symbols are not the most accessible and this could be missed easily, so should add some text to each of these.

@agilgur5
Copy link
Collaborator

Superseded by #848

@agilgur5 agilgur5 closed this Sep 17, 2020
@agilgur5 agilgur5 added the solution: unnecessary This PR makes unnecessary or redundant changes label Sep 17, 2020
@agilgur5
Copy link
Collaborator

@allcontributors please add @strdr4605 for idea

@allcontributors
Copy link
Contributor

@agilgur5

I've put up a pull request to add @strdr4605! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
solution: unnecessary This PR makes unnecessary or redundant changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants