Skip to content
Marcos Caceres edited this page Mar 28, 2026 · 5 revisions

.issue

Marks content as an open issue box. When used with github, can automatically embed a GitHub issue by number.

Usage

<div class="issue">
  <p>We need to decide whether this should be synchronous.</p>
</div>
<div class="issue" data-number="363"></div>
<p class="issue" title="Needs resolution">
  Should this be normative?
</p>
<div class="issue atrisk" data-number="42">
  <p>This feature may be removed before publication.</p>
</div>

Feature at Risk

Adding class="atrisk" alongside class="issue" renders the heading as "(Feature at Risk) Issue N" — the W3C Process convention for marking features under review during CR.

When atRiskBase is configured, data-number links to that tracker instead of issueBase:

var respecConfig = {
  issueBase: "https://github.com/example/repo/issues/",
  atRiskBase: "https://github.com/example/repo/issues/",
};

Notes

  • When data-number is set and github is configured, ReSpec downloads the issue content from GitHub and embeds it
  • GitHub issues with state: "CLOSED" render with a closed CSS class
  • The title attribute is interpreted as HTML — see title attributes
  • Works inline: <span class="issue">…</span> renders as a compact inline issue marker
  • Use issue-summary to generate a collected list of all issues in the document
  • Issues are numbered automatically (e.g. "Issue 1", "Issue 2")

Guides

Configuration options

W3C Configuration options

Linting rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

HTML attributes

CSS Classes

Special properties

Clone this wiki locally