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.
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:
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 have been moved out of ReSpec. You want to use speref.org.
Documentation for ReSpec is available in our wiki.
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.
FAQs
A technical specification pre-processor.
The npm package respec receives a total of 1,495 weekly downloads. As such, respec popularity was classified as popular.
We found that respec demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
