docs-v2
docs-v2 copied to clipboard
Automagically add relative link marker
Github has a nice relative link marker on documentation:

We should add something similar to our documentation:

@danielbachhuber - I understand the req.
In terms of implementation I propose:
- Use the same "chain" icon as github, with the same functionality (visible on mouseover, click to follow the link).
- Icon appears alongside any heading
<h1-6>with an id attribute. - The icon is added by JS in the document's ready() function.
Does this sound good?
An alternative to the last point would be to add the icon's HTML during the build - if I understand correctly this is done with the redcarpet gem. I'm not familiar with this, but if it can be customised I could potentially do it this way.
JS sounds find to me if the Ruby approach is too difficult.
IMO this should just be in done the jekyll templates
@joehoyle - sounds reasonable, I'll look into this.
FWIW, we can't run arbitrary Ruby; Jekyll supports plugins and such, but GH Pages is locked down much tighter.
Awesome - just came here to request this as I'd like to link to the docs halfway down.