Process descriptions for @link tags. #79
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Symbols within the same AST are linked via generated hash targets. Absolute URLs starting with `http://` and `https://` are linked normally. Any other values are not linked and output as text. Note: Cross-AST (aka multi-file) symbol linking could be achieved in the future by creating a global symbol map before generating the output.
|
This change is useful for generating a same-page index with links to symbols. Here's an example: Let me know what you think! |
|
Looks great @nicksay. Nice job! +1 from me. I originally thought this would be done in lib/analyze, but it would be redundant operation across many types. Putting it in lib/generateMD is quite convenient. Thanks for contributing. |
|
Thanks @mrjoelkemp. @psq any thoughts? |
|
sorry guys, somehow I totally missed this PR. So thanks for the gentle ping, @nicksay. Looks quite nice. Will merge and release. |
psq
added a commit
that referenced
this pull request
Jan 12, 2015
Process descriptions for @link tags.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Symbols within the same AST are linked via generated hash targets. Absolute
URLs starting with
http://andhttps://are linked normally. Any othervalues are not linked and output as text.
Note: Cross-AST (aka multi-file) symbol linking could be achieved in the future
by creating a global symbol map before generating the output.