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 c134498ec8
chore(package): build, then start server (#1558)
5 years ago
builds v20.0.3 5 years ago
examples fix(examples/basic): revert accidental changes 5 years ago
js fix(core/aria): Remove core/aria module (#1544) 5 years ago
src refactor(w3c/informative): remove jQuery (#1553) 5 years ago
tests fix(core/aria): Remove core/aria module (#1544) 5 years ago
tools fix(tools/release): correct path for input file 5 years ago
worker fix(worker/respec-worker): offline error-handling 5 years ago
.babelrc BREAKING CHANGE: use jQuery slim (#1432) 5 years ago
.editorconfig Changed to use 2 instead of 4 spaces 7 years ago
.eslintrc.json chore(.eslintrc): reconfigure eslint 5 years ago
.gitattributes chore(.gitattributes): add auto for text 6 years ago
.gitignore chore(.gitignore): use globs (#1518) 5 years ago
.jscsrc Fix(jscs): esnext rule was removed from 3.0 7 years ago
.jshintrc chore(deps): move dependencies to js/deps (closes #633) 7 years ago
.npmignore refactor(copydeps): convert to nodejs script (closes #954) (#957) 6 years ago
.snyk fix: package.json & .snyk to reduce vulnerabilities 5 years ago
.travis.yml fix: re-add sudo required (#1509) 5 years ago
.vscode chore(.vscode): add Visual Studio config 5 years ago
CHANGELOG.md chore(CHANGELOG): regenerate 5 years ago
CODE_OF_CONDUCT.md docs: http -> https (#1190) 6 years ago
LICENSE.md chore(LICENSE): add LICENSE.md file (closes #1317) 5 years ago
README.md Docs: fix link to editor's guide 5 years ago
karma.conf.js Skip detectBrowsers when explicitly passing browsers (#1490) 5 years ago
package-lock.json chore(package-lock): regenerate 5 years ago
package.json chore(package): build, then start server (#1558) 5 years ago
yarn.lock chore(yarn): update lock file 5 years ago

README.md

ReSpec

Greenkeeper badge Build Status Known Vulnerabilities

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.