Fix broken anchor links (#464, #465) #567
Conversation
There was a problem hiding this comment.
I was able to use the newly added group property by adding the following {{group_name}} code to see.html.njk in sassdoc-theme-default:
{% set group_name = '' %}
{% if see.group %}
{% set group_name = see.group + '-' %}
{% endif %}
<li><span class="item__cross-type">[{{ see.context.type }}]</span> <a href="#{{ group_name }}{{ see.context.type }}-{{ see.context.name }}"><code>{{ see.context.name | unescape }}</code></a></li>
That being said, its highly likely to give the incorrect group if there's more than on context with the same name. I commented on the line that does the lookup, which is an existing issue prior to this change.
| @@ -14,6 +14,7 @@ export default function alias (env) { | |||
|
|
|||
| let alias = item.alias | |||
| let name = item.context.name | |||
| let aliasGroup = item.group | |||
|
|
|||
| let aliasedItem = Array.find(data, i => i.context.name === alias) | |||
There was a problem hiding this comment.
This lookup finds the first instance of the alias name, which could be incorrect if there's more than one context with the same name.
|
@d13 thanks for reviewing! So my understanding is that this solution is not perfect but still yields better results than if we don't land it. Also it needs extra theme code to be useful. What I can do is:
Does that sounds good? As for the alias issue when multiple contexts share the same name, I'm not sure from the top of my head how that can be fixed (haven't worked with SassDoc in the past... many years) but I'll definitely accept a PR for it! |
|
@valeriangalliat thanks! Yes, I agree this is an improvement! I'll definitely put up the PR for I'll also put some time into how to solve the alias with same name issue. (sorry for the confusion in users, just realized i'm commenting from my work account) |
|
Great! Thanks for the PR on sassdoc-theme-default This is released with sassdoc@2.7.4 |
Rebased version of #465 with addressed PR comments.
Fixes #464, closes #465.