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

Make Section Headings Linkable #138

Open
jtfairbank opened this issue Jan 11, 2016 · 0 comments
Open

Make Section Headings Linkable #138

jtfairbank opened this issue Jan 11, 2016 · 0 comments

Comments

@jtfairbank
Copy link

First off, thanks soooo much for all the hard work on Handlebars. I hope you're proud that you've saved so many people so much time, and are used in a ton of great apps.

My Problem / Use Case

I want to link to specific parts of the Handlebars documentation within each page. Examples:

  • Slack my co-worker the section of the docs he needs (maybe a specific block helper function).
  • Create an issue with some new or previously unknown Handlebars functionality that I'd like to improve the codebase with.
  • Include references to the Handlebars docs within our own docs (code review checklists, Readme's and codebase tutorials, comments, etc).

Right now the best options are:

  • Inspect the html and snag the heading's id, then manually add an anchor to the end of the url (http://handlebarsjs.com/block_helpers.html#basic-blocks).
  • Link to the page and also include the heading or some text to search for.

Suggested Fix

Just put an anchor link in the <h2> tags, or vice versa. The output html for the Block Helper Page would look like:

<h2 id="basic-blocks">
    <a href="#basic-blocks">Basic Blocks</a>
</h2>

El Fin

Sorry I can't help with a pull request- I don't know ruby. :/ Happy to buy you a beer via paypal, git tip, etc if you implement this request!

Happy coding,
Taylor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant