[FEATURE] Support for link to sub object within documents
See original GitHub issueOverview of the issue
Add an Id or Name tag to sub objects within documents, such as a link to the name of a method. which can be accessed with markdown syntax from outside the document.
[link]('./file#method-name')
Operating System, Node.js, npm, compodoc version(s)
node -v v6.9.4 npm -v 3.10.10
“@compodoc/compodoc”: “^1.0.0-beta.10”,
Compodoc installed globally or locally ?
locally
Motivation for or Use Case
Main reason is trying to find a simple solution to avoid duplication of documentation between abstract methods and their implementation. I would like to link the implementation description to the abstract declaration.
Could also be used to generate a table of contents of methods for example.
Suggest a Fix
Add <a name="{{name}}"></a>
to lines such as
<b>{{#if modifierKind}}<span class="modifier">{{modifKind modifierKind}}</span>{{/if}} <a name="{{name}}"></a>{{name}}</b>
in block-method.hbs
Issue Analytics
- State:
- Created 6 years ago
- Comments:6 (2 by maintainers)
Top Results From Across the Web
Linked objects and embedded objects - Microsoft Support
The main differences between linked objects and embedded objects are where the data is stored and how you update the data after you...
Read more >Use linked content features in InDesign - Adobe Support
You can place and link objects using either the Content Collector tools, or choose Edit > Place and Link menu command. The icon...
Read more >[Feature request] Support indexing nested fields #227 - GitHub
I'd like to set up my collection like this const schema = { name: 'links', num_documents: 0, fields: [ { name: 'company.name', type:...
Read more >Custom Link Example: Link to Documents - Salesforce Help
Use custom links to reference documents from a Salesforce record detail page.Required Editions and User Permissions Available in: Salesforce Classic (not...
Read more >Links in HTML documents - W3C
Since links may point to documents encoded with different character encodings, the A and LINK elements support the charset attribute. This attribute allows ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Thanks for your help confirmed working as expected version 1.0.1.
Really like the tool.
@petemcwilliams this should work now with 1.0.1