Skip to content

Commit ec0c849

Browse files
committed
Remove span tags from template
Now that we've switched to hosting our API docs with Docsify, we don't need the span tags to ensure that the section navigation works properly. They also appear in the search results on Docsify, which makes the search hard to read and a little unsightly.
1 parent 28bef6e commit ec0c849

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lib/rspec/api_doc/templates/api_doc_json_template.md.erb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<% end %>
1111
<% sections.each do |section| %>
1212

13-
## <span id="<%= section.header_ref %>"><%= section.header %></span>
13+
## <%= section.header %>
1414

1515
<% if section.recorded_request? %>
1616
```http
@@ -25,7 +25,7 @@
2525

2626
<% end %>
2727
<% if section.parameters? %>
28-
### <span id="<%= section.header_ref %>-parameters">Parameters</span>
28+
### Parameters
2929

3030
<% if section.custom_parameters_info %>
3131
<%= section.custom_parameters_info %>
@@ -42,7 +42,7 @@ All <%= resource %> **must** be sent in an array nested under a top level
4242
<% end %>
4343

4444
<% if section.recorded_request? && section.request_json.present? %>
45-
### <span id="<%= section.header_ref %>-example">Example</span>
45+
### Example
4646

4747
<% if section.example_explanation.present? %>
4848
<%= section.example_explanation %>
@@ -56,7 +56,7 @@ All <%= resource %> **must** be sent in an array nested under a top level
5656
<% end %>
5757
<% end %>
5858
<% if section.recorded_response? %>
59-
### <span id="<%= section.header_ref %>-response">Response</span>
59+
### Response
6060

6161
```http
6262
Status: <%= section.response_status %>
@@ -72,7 +72,7 @@ Status: <%= section.response_status %>
7272
```
7373
<% end %>
7474

75-
### <span id="<%= section.header_ref %>-curl-example">Curl Example</span>
75+
### Curl Example
7676

7777
```sh
7878
<%= RSpec::ApiDoc::StandardCurlExample.new(section).build %>

0 commit comments

Comments
 (0)