A tool for creating technical documents and web standards.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Marcos Cáceres 38ad655538 v28.0.5 4 days ago
.github chore(ci): use cache option of setup-node (#3692) 4 months ago
.vscode chore: gitignore vscode settings (#3286) 10 months ago
builds v28.0.5 4 days ago
examples refactor: remove duplicate initialization code in profiles (#3666) 4 months ago
js/deps chore(deps-dev): use updated rollup plugins (#3392) 8 months ago
profiles refactor: remove duplicate initialization code in profiles (#3666) 4 months ago
src fix(core/id-headers): improve and localize aria-label (#3874) 4 days ago
tests fix(core/id-headers): improve and localize aria-label (#3874) 4 days ago
tools BREAKING CHANGE: switch to Node 16 (LTS) + update deps (#3846) 3 weeks ago
worker refactor: build respec-highlight alongside respec-worker (#3390) 8 months ago
.editorconfig Changed to use 2 instead of 4 spaces 6 years ago
.eslintrc.json chore: remove unused files, config and packges (#3400) 8 months ago
.gitignore chore: gitignore vscode settings (#3286) 10 months ago
CHANGELOG.md chore(CHANGELOG): regenerate (#3607) 5 months ago
CODE_OF_CONDUCT.md chore(CODE_OF_CONDUCT): update enforcement contacts (#2802) 2 years ago
CONTRIBUTING.md Create CONTRIBUTING.md 4 years ago
LICENSE chore(LICENSE): Update text to 2015 version (#2742) 2 years ago
README.md chore: remove snyk (#3299) 9 months ago
package-lock.json v28.0.5 4 days ago
package.json v28.0.5 4 days ago
serve.json chore(server): don't clear file extensions 3 years ago

README.md

ReSpec

Backers on Open Collective Sponsors on Open Collective Build Status Website status

ReSpec is a JS library that makes it easier to write technical specifications, or documents that tend to be technical in nature in general. It was originally designed for the purpose of writing W3C specifications, but has since grown to be able to support other outputs as well.

Getting started

If you are just interested in writing a spec, you can grab the starter spec.

We have extensive documentation on how to use ReSpec in our wiki, including:

You don't need to check-out or fork this repository.

If you are new to spec writing, we strongly encourage you to read:

Getting help

If you experience issues, please email spec-prod@w3.org or if you think something is broken, file a bug.

Please note: ReSpec is not endorsed by W3C and nobody should expect the W3C Webmaster to provide advice on problems encountered with ReSpec, or on why it may be failing to produce pubrules-compliant content.

Bibliographical references

Bibliographical references have been moved out of ReSpec. You want to use specref.org.

Want to see complete documentation?

Documentation for ReSpec is available in our wiki.

Contribute

Please see our developer guide.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

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]