Skip to content
Marcos Cáceres edited this page Nov 11, 2021 · 11 revisions

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

github

The github option allows you associate your specification with a repository on GitHub.

It takes either a string (URL to your repo or a string of format: org/repo) or an object with the following properties:

This automatically generates:

It adds "Feedback:" to the header of the document, with the appropriate links to your GitHub repository.

feedback header, with links to pull request, open issues, and create new issue on Github

This is normally what you want:

var respecConfig = {
  github: "w3c/browser-payment-api",
};
var respecConfig = {
  github: "https://github.com/w3c/browser-payment-api",
};

This example shows a repository whose specs are being served from a "public-docs" branch.

var respecConfig = {
  github: {
    repoURL: "https://github.com/w3c/browser-payment-api",
    branch: "public-docs", // alternative branch
  },
};