Skip to content

Commit 93f6dec

Browse files
authored
Add anchor.js (#18)
* Add anchor.js * Call anchors.add() * anchor.js visible: always * Update src * Hacky anchor headings * Modify max_level for toc
1 parent 1b4835c commit 93f6dec

File tree

676 files changed

+982
-949
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

676 files changed

+982
-949
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ twitter:
1010
card: summary
1111
toc:
1212
min_level: 2
13-
max_level: 5
13+
max_level: 3
1414
defaults:
1515
- scope:
1616
path: ""

src/_layouts/default.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656

5757
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
5858
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
59+
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.0/anchor.min.js"></script>
5960
<script src="/assets/js/app.js"></script>
6061
</body>
6162
</html>

src/_sass/railsdoc.scss

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ code {
6969

7070
a {
7171
color: rgba(0, 0, 0, .8);
72+
font-size: .8rem;
7273

7374
&:hover {
7475
color: $dark-red;
@@ -162,8 +163,26 @@ code {
162163
}
163164

164165
#content {
166+
$hacky-div-height: 4rem;
167+
165168
h2 {
166-
padding-top: .5em;
169+
margin-top: 2rem;
170+
}
171+
172+
h3 {
173+
margin-top: 1.5rem;
174+
}
175+
176+
h4 {
177+
margin-top: 1rem;
178+
}
179+
180+
h2[id]::before, h3[id]::before, h4[id]::before, h5[id]::before {
181+
display: block;
182+
height: $hacky-div-height;
183+
margin-top: -$hacky-div-height;
184+
visibility: hidden;
185+
content: "";
167186
}
168187

169188
.attr-name {
@@ -253,3 +272,12 @@ code {
253272
.ruby-number {
254273
color: #40A070;
255274
}
275+
276+
.anchorjs-link {
277+
color: #AAAAAA;
278+
279+
&:hover {
280+
color: $red;
281+
text-decoration: none;
282+
}
283+
}

src/assets/js/app.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,7 @@ $(() => {
55
});
66

77
hljs.initHighlightingOnLoad();
8+
9+
anchors.options.visible = 'always';
10+
anchors.add();
811
});

src/classes/AbstractController/Base.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ <h2 id="attributes">Attributes</h2>
230230

231231
<!-- Methods -->
232232

233-
<h2 id="methods">Class Public methods</h2>
233+
<h2 id="class-public-methods">Class Public methods</h2>
234234

235235
<div class="method">
236236
<h3 id="method-c-abstract-21">
@@ -509,7 +509,7 @@ <h3 id="method-c-supports_path-3F">
509509

510510

511511

512-
<h2 id="methods">Instance Public methods</h2>
512+
<h2 id="instance-public-methods">Instance Public methods</h2>
513513

514514
<div class="method">
515515
<h3 id="method-i-action_methods">

src/classes/AbstractController/Caching.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h2 id="included-modules">Included Modules</h2>
117117
<!-- Methods -->
118118

119119

120-
<h2 id="methods">Instance Public methods</h2>
120+
<h2 id="instance-public-methods">Instance Public methods</h2>
121121

122122
<div class="method">
123123
<h3 id="method-i-view_cache_dependencies">
@@ -155,7 +155,7 @@ <h3 id="method-i-view_cache_dependencies">
155155
</div>
156156

157157

158-
<h2 id="methods">Instance Private methods</h2>
158+
<h2 id="instance-private-methods">Instance Private methods</h2>
159159

160160
<div class="method">
161161
<h3 id="method-i-cache">

src/classes/AbstractController/Caching/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2 id="methods">Methods</h2>
6464
<!-- Methods -->
6565

6666

67-
<h2 id="methods">Instance Public methods</h2>
67+
<h2 id="instance-public-methods">Instance Public methods</h2>
6868

6969
<div class="method">
7070
<h3 id="method-i-view_cache_dependency">

src/classes/AbstractController/Caching/ConfigMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ <h2 id="methods">Methods</h2>
6969
<!-- Methods -->
7070

7171

72-
<h2 id="methods">Instance Public methods</h2>
72+
<h2 id="instance-public-methods">Instance Public methods</h2>
7373

7474
<div class="method">
7575
<h3 id="method-i-cache_store">

src/classes/AbstractController/Caching/Fragments.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ <h2 id="methods">Methods</h2>
141141
<!-- Methods -->
142142

143143

144-
<h2 id="methods">Instance Public methods</h2>
144+
<h2 id="instance-public-methods">Instance Public methods</h2>
145145

146146
<div class="method">
147147
<h3 id="method-i-combined_fragment_cache_key">

src/classes/AbstractController/Caching/Fragments/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2 id="methods">Methods</h2>
6464
<!-- Methods -->
6565

6666

67-
<h2 id="methods">Instance Public methods</h2>
67+
<h2 id="instance-public-methods">Instance Public methods</h2>
6868

6969
<div class="method">
7070
<h3 id="method-i-fragment_cache_key">

src/classes/AbstractController/Callbacks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h2 id="included-modules">Included Modules</h2>
126126
<!-- Methods -->
127127

128128

129-
<h2 id="methods">Instance Public methods</h2>
129+
<h2 id="instance-public-methods">Instance Public methods</h2>
130130

131131
<div class="method">
132132
<h3 id="method-i-process_action">

src/classes/AbstractController/Callbacks/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h2 id="methods">Methods</h2>
157157
<!-- Methods -->
158158

159159

160-
<h2 id="methods">Instance Public methods</h2>
160+
<h2 id="instance-public-methods">Instance Public methods</h2>
161161

162162
<div class="method">
163163
<h3 id="method-i-_insert_callbacks">

src/classes/AbstractController/Collector.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h2 id="methods">Methods</h2>
6363

6464
<!-- Methods -->
6565

66-
<h2 id="methods">Class Public methods</h2>
66+
<h2 id="class-public-methods">Class Public methods</h2>
6767

6868
<div class="method">
6969
<h3 id="method-c-generate_method_for_mime">

src/classes/AbstractController/DoubleRenderError.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ <h2 id="constants">Constants</h2>
8787

8888
<!-- Methods -->
8989

90-
<h2 id="methods">Class Public methods</h2>
90+
<h2 id="class-public-methods">Class Public methods</h2>
9191

9292
<div class="method">
9393
<h3 id="method-c-new">

src/classes/AbstractController/Helpers/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h2 id="methods">Methods</h2>
105105
<!-- Methods -->
106106

107107

108-
<h2 id="methods">Instance Public methods</h2>
108+
<h2 id="instance-public-methods">Instance Public methods</h2>
109109

110110
<div class="method">
111111
<h3 id="method-i-clear_helpers">

src/classes/AbstractController/Helpers/MissingHelperError.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ <h2 id="methods">Methods</h2>
6969

7070
<!-- Methods -->
7171

72-
<h2 id="methods">Class Public methods</h2>
72+
<h2 id="class-public-methods">Class Public methods</h2>
7373

7474
<div class="method">
7575
<h3 id="method-c-new">

src/classes/AbstractController/Railties/RoutesHelpers.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h2 id="methods">Methods</h2>
6363

6464
<!-- Methods -->
6565

66-
<h2 id="methods">Class Public methods</h2>
66+
<h2 id="class-public-methods">Class Public methods</h2>
6767

6868
<div class="method">
6969
<h3 id="method-c-with">

src/classes/AbstractController/Rendering.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h2 id="constants">Constants</h2>
147147
<!-- Methods -->
148148

149149

150-
<h2 id="methods">Instance Public methods</h2>
150+
<h2 id="instance-public-methods">Instance Public methods</h2>
151151

152152
<div class="method">
153153
<h3 id="method-i-render">
@@ -342,7 +342,7 @@ <h3 id="method-i-view_assigns">
342342
</div>
343343

344344

345-
<h2 id="methods">Instance Private methods</h2>
345+
<h2 id="instance-private-methods">Instance Private methods</h2>
346346

347347
<div class="method">
348348
<h3 id="method-i-_normalize_args">

src/classes/AbstractController/Translation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h2 id="methods">Methods</h2>
8686
<!-- Methods -->
8787

8888

89-
<h2 id="methods">Instance Public methods</h2>
89+
<h2 id="instance-public-methods">Instance Public methods</h2>
9090

9191
<div class="method">
9292
<h3 id="method-i-l">

src/classes/AbstractController/UrlFor.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h2 id="included-modules">Included Modules</h2>
9999
<!-- Methods -->
100100

101101

102-
<h2 id="methods">Instance Public methods</h2>
102+
<h2 id="instance-public-methods">Instance Public methods</h2>
103103

104104
<div class="method">
105105
<h3 id="method-i-_routes">

src/classes/AbstractController/UrlFor/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h2 id="methods">Methods</h2>
7676
<!-- Methods -->
7777

7878

79-
<h2 id="methods">Instance Public methods</h2>
79+
<h2 id="instance-public-methods">Instance Public methods</h2>
8080

8181
<div class="method">
8282
<h3 id="method-i-_routes">

src/classes/ActionCable.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ <h2 id="methods">Methods</h2>
183183

184184
<!-- Methods -->
185185

186-
<h2 id="methods">Class Public methods</h2>
186+
<h2 id="class-public-methods">Class Public methods</h2>
187187

188188
<div class="method">
189189
<h3 id="method-c-gem_version">

src/classes/ActionCable/Channel/Base.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ <h2 id="attributes">Attributes</h2>
358358

359359
<!-- Methods -->
360360

361-
<h2 id="methods">Class Public methods</h2>
361+
<h2 id="class-public-methods">Class Public methods</h2>
362362

363363
<div class="method">
364364
<h3 id="method-c-action_methods">
@@ -457,7 +457,7 @@ <h3 id="method-c-new">
457457
</div>
458458

459459

460-
<h2 id="methods">Class Private methods</h2>
460+
<h2 id="class-private-methods">Class Private methods</h2>
461461

462462
<div class="method">
463463
<h3 id="method-c-clear_action_methods-21">
@@ -532,7 +532,7 @@ <h3 id="method-c-method_added">
532532

533533

534534

535-
<h2 id="methods">Instance Public methods</h2>
535+
<h2 id="instance-public-methods">Instance Public methods</h2>
536536

537537
<div class="method">
538538
<h3 id="method-i-perform_action">
@@ -619,7 +619,7 @@ <h3 id="method-i-subscribe_to_channel">
619619
</div>
620620

621621

622-
<h2 id="methods">Instance Private methods</h2>
622+
<h2 id="instance-private-methods">Instance Private methods</h2>
623623

624624
<div class="method">
625625
<h3 id="method-i-defer_subscription_confirmation-21">

src/classes/ActionCable/Channel/Broadcasting/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2 id="methods">Methods</h2>
6464
<!-- Methods -->
6565

6666

67-
<h2 id="methods">Instance Public methods</h2>
67+
<h2 id="instance-public-methods">Instance Public methods</h2>
6868

6969
<div class="method">
7070
<h3 id="method-i-broadcast_to">

src/classes/ActionCable/Channel/Callbacks/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h2 id="methods">Methods</h2>
103103
<!-- Methods -->
104104

105105

106-
<h2 id="methods">Instance Public methods</h2>
106+
<h2 id="instance-public-methods">Instance Public methods</h2>
107107

108108
<div class="method">
109109
<h3 id="method-i-after_subscribe">

src/classes/ActionCable/Channel/Naming/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2 id="methods">Methods</h2>
6464
<!-- Methods -->
6565

6666

67-
<h2 id="methods">Instance Public methods</h2>
67+
<h2 id="instance-public-methods">Instance Public methods</h2>
6868

6969
<div class="method">
7070
<h3 id="method-i-channel_name">

src/classes/ActionCable/Channel/PeriodicTimers/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2 id="methods">Methods</h2>
6464
<!-- Methods -->
6565

6666

67-
<h2 id="methods">Instance Public methods</h2>
67+
<h2 id="instance-public-methods">Instance Public methods</h2>
6868

6969
<div class="method">
7070
<h3 id="method-i-periodically">

src/classes/ActionCable/Channel/Streams.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h2 id="methods">Methods</h2>
137137
<!-- Methods -->
138138

139139

140-
<h2 id="methods">Instance Public methods</h2>
140+
<h2 id="instance-public-methods">Instance Public methods</h2>
141141

142142
<div class="method">
143143
<h3 id="method-i-stop_all_streams">

src/classes/ActionCable/Connection/Authorization.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h2 id="methods">Methods</h2>
7777
<!-- Methods -->
7878

7979

80-
<h2 id="methods">Instance Public methods</h2>
80+
<h2 id="instance-public-methods">Instance Public methods</h2>
8181

8282
<div class="method">
8383
<h3 id="method-i-reject_unauthorized_connection">

src/classes/ActionCable/Connection/Base.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ <h2 id="attributes">Attributes</h2>
265265

266266
<!-- Methods -->
267267

268-
<h2 id="methods">Class Public methods</h2>
268+
<h2 id="class-public-methods">Class Public methods</h2>
269269

270270
<div class="method">
271271
<h3 id="method-c-new">
@@ -314,7 +314,7 @@ <h3 id="method-c-new">
314314

315315

316316

317-
<h2 id="methods">Instance Public methods</h2>
317+
<h2 id="instance-public-methods">Instance Public methods</h2>
318318

319319
<div class="method">
320320
<h3 id="method-i-beat">
@@ -462,7 +462,7 @@ <h3 id="method-i-statistics">
462462
</div>
463463

464464

465-
<h2 id="methods">Instance Private methods</h2>
465+
<h2 id="instance-private-methods">Instance Private methods</h2>
466466

467467
<div class="method">
468468
<h3 id="method-i-cookies">

src/classes/ActionCable/Connection/Identification.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h2 id="methods">Methods</h2>
7777
<!-- Methods -->
7878

7979

80-
<h2 id="methods">Instance Public methods</h2>
80+
<h2 id="instance-public-methods">Instance Public methods</h2>
8181

8282
<div class="method">
8383
<h3 id="method-i-connection_identifier">

src/classes/ActionCable/Connection/Identification/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2 id="methods">Methods</h2>
6464
<!-- Methods -->
6565

6666

67-
<h2 id="methods">Instance Public methods</h2>
67+
<h2 id="instance-public-methods">Instance Public methods</h2>
6868

6969
<div class="method">
7070
<h3 id="method-i-identified_by">

0 commit comments

Comments
 (0)