fix(docs): Add anchor links to generated reference docs

Fixes #60
contentful · Apr 5, 2016 · 4a9576f · 4a9576f
1 parent eb3904b
commit 4a9576f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/jsdoc-template/tmpl/members.tmpl b/jsdoc-template/tmpl/members.tmpl
@@ -2,7 +2,10 @@
 var data = obj;
 var self = this;
 ?>
-<h4 class="name" id="<?js= id ?>"><?js= data.attribs + name + (data.signature ? data.signature : '') ?></h4>
+<h4 class="name" id="<?js= id ?>">
+  <?js= data.attribs + name + (data.signature ? data.signature : '') ?>
+  <a href="#<?js= id ?>">#</a>
+</h4>
 
 <?js if (data.summary) { ?>
 <p class="summary"><?js= summary ?></p>

diff --git a/jsdoc-template/tmpl/method.tmpl b/jsdoc-template/tmpl/method.tmpl
@@ -7,8 +7,10 @@ var self = this;
     <h2>Constructor</h2>
     <?js } ?>
 
-    <h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '') +
-    name + (data.signature || '') ?></h4>
+    <h4 class="name" id="<?js= id ?>">
+      <?js= data.attribs + (kind === 'class' ? 'new ' : '') + name + (data.signature || '') ?>
+      <a href="#<?js= id ?>">#</a>
+    </h4>
 
     <?js if (data.summary) { ?>
     <p class="summary"><?js= summary ?></p>