otherLinks - speced/respec GitHub Wiki

otherLinks

Type: OtherLink[] Default: []

Adds custom link sections to the document header. Use this to link to implementation trackers, test suites, issue trackers in other repos, or any other relevant resources.

Basic usage

var respecConfig = {
  otherLinks: [
    {
      key: "Implementation status",
      data: [
        {
          value: "Chrome",
          href: "https://chromestatus.com/feature/12345",
        },
        {
          value: "Firefox",
          href: "https://bugzilla.mozilla.org/show_bug.cgi?id=12345",
        },
        {
          value: "Safari",
          href: "https://bugs.webkit.org/show_bug.cgi?id=12345",
        },
      ],
    },
  ],
};

Structure

Each entry in otherLinks is an object:

Field Type Description
key string Section heading shown in the header
data LinkData[] Array of link items

Each item in data:

Field Type Description
value string Link text (or plain text if no href)
href string URL. Omit to display value as plain text.

Notes

  • Appears in the document header alongside "Editors", "Authors", and "Feedback" links
  • Multiple otherLinks entries each get their own section heading