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.
 
 
 
Sid Vishnoi f068b6dd77
feat(tools/respec2html): add --version flag (#3343)
22 hours ago
.github chore: remove snyk (#3299) 1 week ago
.vscode chore: gitignore vscode settings (#3286) 3 weeks ago
assets fix(assets/respec.css): darken pre background in examples (#3339) 1 day ago
builds v26.0.2 1 day ago
examples fix(examples/starter.html): user newer syntax/features (#3313) 1 week ago
js/deps BREAKING CHANGE: remove menu keyboard shortcuts (#3237) 2 months ago
profiles fix(w3c): prevent CG/BGs from using wrong status (#3322) 2 days ago
src fix(w3c/defaults): regression detecting valid specStatus (#3337) 2 days ago
tests fix(core/anchor-expander): convert nested header links to spans (#3331) 2 days ago
tools feat(tools/respec2html): add --version flag (#3343) 22 hours ago
worker chore(core/highlight): remove .js extension to support brotli on server (#3002) 7 months ago
.editorconfig Changed to use 2 instead of 4 spaces 5 years ago
.eslintignore refactor: remove hljs config from profile (#2201) 1 year ago
.eslintrc.json chore: update dependencies (#2954) 8 months ago
.gitignore chore: gitignore vscode settings (#3286) 3 weeks ago
CHANGELOG.md chore(CHANGELOG): regenerate (#3341) 1 day ago
CODE_OF_CONDUCT.md chore(CODE_OF_CONDUCT): update enforcement contacts (#2802) 11 months ago
CONTRIBUTING.md Create CONTRIBUTING.md 3 years ago
LICENSE chore(LICENSE): Update text to 2015 version (#2742) 1 year ago
README.md chore: remove snyk (#3299) 1 week ago
karma.conf.js chore(karma.conf.js): remove unused config (#2877) 9 months ago
package-lock.json v26.0.2 1 day ago
package.json v26.0.2 1 day ago
serve.json chore(server): don't clear file extensions 2 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]