Skip to content
Marcos Cáceres edited this page Oct 13, 2025 · 7 revisions

index

Adding a <section id="index"> in your document instructs ReSpec to gather all the terms defined in your specification, as well as all the terms referenced by your specification into a single section. The index lets you conveniently search for all defined/referenced terms, as well as find their usage in the document.

<section id="index" class="appendix">
  <!-- All the terms will magically appear here -->
</section>

You can also add a custom header and content to your index:

<section id="index" class="appendix">
  <h2>List All The Terms!</h2>
  <p>Wow, that's a lot of terms!</p>
  <!-- All the terms will magically appear here -->
</section>

If you'd lie to show the full spec/document's title in the index, you can add the special "prefer-full-spec-title" CSS class, like so:

<section class="prefer-full-spec-title appendix" id="index">

So, for example, instead of "[DOM]", the document will show "DOM Standard" in the index.

Guides

Configuration options

W3C Configuration options

Linter rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

WebIDL

HTML attributes

CSS Classes

Special properties

Clone this wiki locally