ReSpec

ReSpec is a tool for writing W3C specifications and other technical documents. Write your content in HTML, add a <script> tag, and ReSpec handles the boilerplate, formatting, cross-references, bibliography, and validation automatically.

You don't need to install anything. Write an HTML file, open it in a browser, done.

Getting started

Grab the starter spec, change the title, add your name as editor, and start writing. Full documentation is at respec.org/docs:

• Editor's Guide — complete walkthrough for new spec editors
• WebIDL guide — for JavaScript API specifications
• How Do I… — quick answers to common tasks

[!NOTE] This repository is for ReSpec's development. You don't need to clone or fork it to write a spec — just use the starter template above.

New to spec writing?

These resources will help you write better specs:

• API Design Principles — what makes a good web API
• Writing Promise-Using Specifications — async patterns for specs
• Security & Privacy Self-Review Questionnaire — audit your spec before publishing
• Short i18n review checklist — internationalization basics
• Adding another permission? — before adding a new permission type

Bibliography

Use specref.org to look up and cite other specifications in your bibliography. ReSpec resolves [[SPEC-ID]] references automatically. You can also search specref directly from the ReSpec pill menu in any spec.

Getting help

• Email [email protected] for general questions
• File a bug if something is broken

ReSpec is not endorsed by W3C. For W3C publication requirements, consult the W3C Publication Rules.

Contribute

See our developer guide and Code of Conduct.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]