# ReSpec

[![Build Status](https://github.com/speced/respec/workflows/Node%20CI/badge.svg?branch=develop)](https://github.com/speced/respec/actions?query=workflow%3A%22Node+CI%22+branch%3Adevelop)

ReSpec is a tool for writing [W3C](https://www.w3.org/) 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](examples/starter.html), change the title, add your name as editor, and start writing. Full documentation is at **[respec.org/docs](https://respec.org/docs/)**:

- [Editor's Guide](https://respec.org/docs/) — complete walkthrough for new spec editors
- [WebIDL guide](https://respec.org/docs/#WebIDL-Guide) — for JavaScript API specifications
- [How Do I…](https://github.com/speced/respec/wiki/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](https://w3ctag.github.io/design-principles/) — what makes a good web API
- [Writing Promise-Using Specifications](https://www.w3.org/2001/tag/doc/promises-guide) — async patterns for specs
- [Security & Privacy Self-Review Questionnaire](https://w3ctag.github.io/security-questionnaire/) — audit your spec before publishing
- [Short i18n review checklist](https://www.w3.org/International/techniques/shortchecklist.html) — internationalization basics
- [Adding another permission?](https://github.com/w3cping/adding-permissions/blob/master/README.md) — before adding a new permission type

## Bibliography

Use [specref.org](https://www.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 [spec-prod@w3.org](mailto:spec-prod@w3.org) for general questions
- [File a bug](https://github.com/speced/respec/issues) if something is broken

> ReSpec is not endorsed by W3C. For W3C publication requirements, consult the [W3C Publication Rules](https://www.w3.org/pubrules/).

## Contribute

See our [developer guide](https://github.com/speced/respec/wiki/Developers-Guide) and [Code of Conduct](CODE_OF_CONDUCT.md).

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/speced/respec/graphs/contributors"><img src="https://opencollective.com/respec/contributors.svg?width=890&button=false" /></a>


## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/respec#backer)]

<a href="https://opencollective.com/respec#backers" target="_blank"><img src="https://opencollective.com/respec/backers.svg?width=890"></a>


## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/respec#sponsor)]

<a href="https://opencollective.com/respec/sponsor/0/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/1/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/2/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/3/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/4/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/5/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/6/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/7/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/8/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/respec/sponsor/9/website" target="_blank"><img src="https://opencollective.com/respec/sponsor/9/avatar.svg"></a>