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

crossLink entries don't seem to link to the proper anchor #24

Open
toolness opened this issue Mar 29, 2016 · 1 comment
Open

crossLink entries don't seem to link to the proper anchor #24

toolness opened this issue Mar 29, 2016 · 1 comment

Comments

@toolness
Copy link

This might not be a bug on the side of this theme--I'm not sure, because I'm not very experienced with yuidoc. But when I try cross-referencing Modules and Classes, the following Handlebars code:

{{#crossLink "p5.play/createSprite:method"}}{{/crossLink}}

results in a hyperlink to the right file, but the wrong anchor. The anchor in the generated hyperlink is #method_createSprite, yet the actual anchor created by this theme uses a hyphen instead of an underscore (that is, it's #method-createSprite). Hence the link appears to be half-broken.

One fix might be to change the relevant handlebars templates in the partials directory of this theme to use underscores instead of hyphens, but I'm not sure if it's the right fix. If it is, I'm happy to issue a PR.

I'm using yuidocjs v0.10.0, so this might be happening because I'm using the wrong version of yuidoc with this theme? Sorry if this bug report isn't very helpful. 😞

@wyantb
Copy link
Contributor

wyantb commented Mar 31, 2016

Bug report is fine. I suspect you might be correct; at some point I got in the bad habit of just writing my anchors manually (couldn't remember the crossLink syntax >.>).

If you add a crossLink example in the examples folder of this repo, along with a fix commit, should be straightforward enough to review & merge.

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

2 participants