Skip to content

Commit 5fb77bc

Browse files
davedoesdevtmcw
davedoesdev
authored and
tmcw
committed
fix(html output): Fix links between navigation and items in HTML documentation
1 parent 74392cc commit 5fb77bc

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

‎__tests__/__snapshots__/bin.js.snap

+20-20
Original file line numberDiff line numberDiff line change
@@ -50,31 +50,31 @@ exports[`--config 1`] = `
5050
<li class='h5'><span>Static members</span></li>
5151
5252
<li><a
53-
href='#Klass.isClass'
53+
href='#klassisclass'
5454
class='regular pre-open'>
5555
.isClass
5656
</a></li>
5757
5858
<li><a
59-
href='#Klass.isWeird'
59+
href='#klassisweird'
6060
class='regular pre-open'>
6161
.isWeird
6262
</a></li>
6363
6464
<li><a
65-
href='#Klass.isBuffer'
65+
href='#klassisbuffer'
6666
class='regular pre-open'>
6767
.isBuffer
6868
</a></li>
6969
7070
<li><a
71-
href='#Klass.isArrayOfBuffers'
71+
href='#klassisarrayofbuffers'
7272
class='regular pre-open'>
7373
.isArrayOfBuffers
7474
</a></li>
7575
7676
<li><a
77-
href='#Klass.MAGIC_NUMBER'
77+
href='#klassmagic_number'
7878
class='regular pre-open'>
7979
.MAGIC_NUMBER
8080
</a></li>
@@ -86,13 +86,13 @@ exports[`--config 1`] = `
8686
<li class='h5'><span>Instance members</span></li>
8787
8888
<li><a
89-
href='#Klass#getFoo'
89+
href='#klassgetfoo'
9090
class='regular pre-open'>
9191
#getFoo
9292
</a></li>
9393
9494
<li><a
95-
href='#Klass#withOptions'
95+
href='#klasswithoptions'
9696
class='regular pre-open'>
9797
#withOptions
9898
</a></li>
@@ -105,7 +105,7 @@ exports[`--config 1`] = `
105105
<li class='h5'>Events</li>
106106
107107
<li><a
108-
href='#Klass.event:event'
108+
href='#klasseventevent'
109109
class='regular pre-open'>
110110
ⓔ event
111111
</a></li>
@@ -171,7 +171,7 @@ exports[`--config 1`] = `
171171
<li class='h5'><span>Instance members</span></li>
172172
173173
<li><a
174-
href='#Foo#bar'
174+
href='#foobar'
175175
class='regular pre-open'>
176176
#bar
177177
</a></li>
@@ -198,7 +198,7 @@ exports[`--config 1`] = `
198198
<li class='h5'><span>Static members</span></li>
199199
200200
<li><a
201-
href='#customStreams.passthrough'
201+
href='#customstreamspassthrough'
202202
class='regular pre-open'>
203203
.passthrough
204204
</a></li>
@@ -311,7 +311,7 @@ PeerId.create({ <span class=\\"hljs-attr\\">bits</span>: <span class=\\"hljs-num
311311
<div class='py1 quiet mt1 prose-big'>Static Members</div>
312312
<div class=\\"clearfix\\">
313313
314-
<div class='border-bottom' id='Klass.isClass'>
314+
<div class='border-bottom' id='klassisclass'>
315315
<div class=\\"clearfix small pointer toggle-sibling\\">
316316
<div class=\\"py1 contain\\">
317317
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -388,7 +388,7 @@ This is a [link to something that does not exist]<a href=\\"DoesNot\\">DoesNot</
388388
</div>
389389
</div>
390390
391-
<div class='border-bottom' id='Klass.isWeird'>
391+
<div class='border-bottom' id='klassisweird'>
392392
<div class=\\"clearfix small pointer toggle-sibling\\">
393393
<div class=\\"py1 contain\\">
394394
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -456,7 +456,7 @@ the referenced class type</p>
456456
</div>
457457
</div>
458458
459-
<div class='border-bottom' id='Klass.isBuffer'>
459+
<div class='border-bottom' id='klassisbuffer'>
460460
<div class=\\"clearfix small pointer toggle-sibling\\">
461461
<div class=\\"py1 contain\\">
462462
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -533,7 +533,7 @@ the referenced class type</p>
533533
</div>
534534
</div>
535535
536-
<div class='border-bottom' id='Klass.isArrayOfBuffers'>
536+
<div class='border-bottom' id='klassisarrayofbuffers'>
537537
<div class=\\"clearfix small pointer toggle-sibling\\">
538538
<div class=\\"py1 contain\\">
539539
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -608,7 +608,7 @@ k.isArrayOfBuffers();</pre>
608608
</div>
609609
</div>
610610
611-
<div class='border-bottom' id='Klass.MAGIC_NUMBER'>
611+
<div class='border-bottom' id='klassmagic_number'>
612612
<div class=\\"clearfix small pointer toggle-sibling\\">
613613
<div class=\\"py1 contain\\">
614614
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -662,7 +662,7 @@ k.isArrayOfBuffers();</pre>
662662
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
663663
<div class=\\"clearfix\\">
664664
665-
<div class='border-bottom' id='Klass#getFoo'>
665+
<div class='border-bottom' id='klassgetfoo'>
666666
<div class=\\"clearfix small pointer toggle-sibling\\">
667667
<div class=\\"py1 contain\\">
668668
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -723,7 +723,7 @@ k.isArrayOfBuffers();</pre>
723723
</div>
724724
</div>
725725
726-
<div class='border-bottom' id='Klass#withOptions'>
726+
<div class='border-bottom' id='klasswithoptions'>
727727
<div class=\\"clearfix small pointer toggle-sibling\\">
728728
<div class=\\"py1 contain\\">
729729
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -826,7 +826,7 @@ k.isArrayOfBuffers();</pre>
826826
<div class='py1 quiet mt1 prose-big'>Events</div>
827827
<div class=\\"clearfix\\">
828828
829-
<div class='border-bottom' id='Klass.event:event'>
829+
<div class='border-bottom' id='klasseventevent'>
830830
<div class=\\"clearfix small pointer toggle-sibling\\">
831831
<div class=\\"py1 contain\\">
832832
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -1199,7 +1199,7 @@ like a <a href=\\"#klass\\">klass</a>. This needs a <a href=\\"https://developer
11991199
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
12001200
<div class=\\"clearfix\\">
12011201
1202-
<div class='border-bottom' id='Foo#bar'>
1202+
<div class='border-bottom' id='foobar'>
12031203
<div class=\\"clearfix small pointer toggle-sibling\\">
12041204
<div class=\\"py1 contain\\">
12051205
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
@@ -1296,7 +1296,7 @@ like a <a href=\\"#klass\\">klass</a>. This needs a <a href=\\"https://developer
12961296
<div class='py1 quiet mt1 prose-big'>Static Members</div>
12971297
<div class=\\"clearfix\\">
12981298
1299-
<div class='border-bottom' id='customStreams.passthrough'>
1299+
<div class='border-bottom' id='customstreamspassthrough'>
13001300
<div class=\\"clearfix small pointer toggle-sibling\\">
13011301
<div class=\\"py1 contain\\">
13021302
<a class='icon pin-right py1 dark-link caret-right'>▸</a>

‎src/default_theme/index._

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<li class='h5'><span>Static members</span></li>
3838
<% doc.members.static.forEach(function(member) { %>
3939
<li><a
40-
href='#<%=member.namespace%>'
40+
href='#<%=slug(member.namespace)%>'
4141
class='regular pre-open'>
4242
.<%- member.name %>
4343
</a></li>
@@ -49,7 +49,7 @@
4949
<li class='h5'><span>Instance members</span></li>
5050
<% doc.members.instance.forEach(function(member) { %>
5151
<li><a
52-
href='#<%=member.namespace%>'
52+
href='#<%=slug(member.namespace)%>'
5353
class='regular pre-open'>
5454
#<%- member.name %>
5555
</a></li>
@@ -61,7 +61,7 @@
6161
<li class='h5'><span>Inner members</span></li>
6262
<% doc.members.inner.forEach(function(member) { %>
6363
<li><a
64-
href='#<%=member.namespace%>'
64+
href='#<%=slug(member.namespace)%>'
6565
class='regular pre-open'>
6666
#<%- member.name %>
6767
</a></li>
@@ -73,7 +73,7 @@
7373
<li class='h5'>Events</li>
7474
<% doc.members.events.forEach(function(member) { %>
7575
<li><a
76-
href='#<%=member.namespace%>'
76+
href='#<%=slug(member.namespace)%>'
7777
class='regular pre-open'>
7878
ⓔ <%- member.name %>
7979
</a></li>

‎src/default_theme/section_list._

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="clearfix">
22
<% members.forEach(function(member) { %>
3-
<div class='border-bottom' id='<%- member.namespace %>'>
3+
<div class='border-bottom' id='<%- slug(member.namespace) %>'>
44
<div class="clearfix small pointer toggle-sibling">
55
<div class="py1 contain">
66
<a class='icon pin-right py1 dark-link caret-right'>▸</a>

0 commit comments

Comments
 (0)