Skip to content

Home

Jump to bottom Edit New page
Sid Vishnoi edited this page Jun 30, 2020 · 37 revisions

ReSpec is a tool that makes writing specifications easier. ReSpec handles things like styling, referential integrity, bibliographical data, and other mundane tasks.

User's guide

A detailed user's guide is available.

If you want to hack on ReSpec, we also have a Developers Guide.

Getting up and running

All you need is an HTML document and to set some configuration options. Each configuration option is documented in this Wiki.

<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <title>Replace me with a real title</title>
    <script src='https://www.w3.org/Tools/respec/respec-w3c' class='remove' async></script>
    <script class='remove'>
      var respecConfig = {
        specStatus: "ED",
        editors: [{
          name: "Your Name",
          url: "https://your-site.com",
        }],
        github: "w3c/some-spec",
      };
    </script>
  </head>
  <body>
    <section id='abstract'>
      <p>
        This is required.
      </p>
    </section>
    <section id='sotd'>
      <p>
        This is required.
      </p>
    </section>
    <section id='conformance'>
      <p>
        This is required for specifications that contain normative material.
      </p>
    </section>
    <section data-dfn-for="Foo">
      <h2><dfn>Foo</dfn> interface</h2>
      <pre class="idl">
      interface Foo {
        attribute Bar bar;
        void doTheFoo();
      };
      </pre>
     <p>The {{Foo}} interface is nice. Lets you do stuff.</p>
     <p>The <dfn>bar</dfn> attribute, returns 🍺.</p>
     <p>The <dfn>doTheFoo()</dfn> method, returns nothing.</p>
    </section>
  </body>
</html>

Getting Support

The official support channel for ReSpec is [email protected]. The mailing list archives are available. You can subscribe by sending email to [email protected] with "subscribe" as the subject line.

💖 Support ReSpec by becoming a sponsor via Open Collective. 💖

✨ View rendered version of this documentation at https://respec.org/docs/ ✨

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