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 ids and links to each section header #2555

Open
LuLaValva opened this issue Feb 4, 2025 · 2 comments
Open

docs: add ids and links to each section header #2555

LuLaValva opened this issue Feb 4, 2025 · 2 comments

Comments

@LuLaValva
Copy link
Member

Most documentation sites (including GitHub .md display, HackMD, every web framework documentation I could find) include links next to each header with # hrefs that point to the header itself. This is a useful feature for sharing specific parts of the documentation and it is (in my opinion) a must-have for support.

Image

It has also been suggested that this feature is built alongside a "table of contents" for each page.

@Brijeshthummar02
Copy link

@LuLaValva can you provide header list with file path and correct link so that it will be easy to replace for me.

@LuLaValva
Copy link
Member Author

Thanks for your initiative @Brijeshthummar02, but I think going through and manually replacing every header to include an ID and a link is the wrong solution here. The solution I imagine is a Marko tag that automatically generates an ID with something like github-slugger for each header and adds a link with href="#[generated ID]"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

2 participants