Skip to content

#27 - allow linking to a section with hash syntax #34

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 18, 2017
Merged

#27 - allow linking to a section with hash syntax #34

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a03650f
#27 - allow linking to a section with hash syntax
mickmcgrath13 May 18, 2017
76c2c19
#27 - clean up hashParts logic | add comments
mickmcgrath13 May 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build/build_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

require("./make_default_helpers_test");

var getRenderer = require('./get_renderer'),
getPartials = require('./get_partials'),
Expand Down
8 changes: 7 additions & 1 deletion build/make_default_helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,18 +267,24 @@ module.exports = function(docMap, config, getCurrent, Handlebars){
var replacer = function (match, content) {
var parts = content.match(linkRegExp),
name,
hashParts,
description,
linkText,
docObject;

name = parts ? parts[1].replace('::', '.prototype.') : content;
hashParts = name.split("#");

if(hashParts.length > 1){
name = hashParts[0];
Copy link
Contributor

@chasenlehara chasenlehara May 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’d be nice if there were comments so people reading this code could more easily understand what’s going on here.

Copy link
Contributor Author

@mickmcgrath13 mickmcgrath13 May 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

}

docObject = docMap[name]
if (docObject) {
linkText = parts && parts[2] ? parts[2] : docObject.title || name;
description = docObject.description || name;

return '<a href="' + urlTo(name) + '" title="' + stripMarkdown(description) + '">' + linkText + '</a>';
return '<a href="' + urlTo(name) + (hashParts.length > 1 ? ("#" + hashParts.slice(1).join("#")) : "") + '" title="' + stripMarkdown(description) + '">' + linkText + '</a>';
Copy link
Contributor

@chasenlehara chasenlehara May 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would be easier to read if this logic happened before the string concatenation.

Also, you could use shift to get the name and then you wouldn't have to slice the array here. 😝

Copy link
Contributor Author

@mickmcgrath13 mickmcgrath13 May 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll do that

}

if (httpRegExp.test(name)) {
Expand Down
77 changes: 77 additions & 0 deletions build/make_default_helpers_test.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.