A tool for creating technical documents and web standards
JavaScript HTML CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
builds v18.3.0 Nov 17, 2017
examples docs(examples): use better basic example Oct 26, 2017
js BREAKING CHANGE: use jQuery slim (#1432) Nov 18, 2017
src refactor(w3c/headers): prettier Dec 14, 2017
tests refactor(w3c/headers-spec): prettier Dec 14, 2017
tools BREAKING CHANGE: use jQuery slim (#1432) Nov 18, 2017
worker fix(worker/respec-worker): offline error-handling Jul 17, 2017
.babelrc BREAKING CHANGE: use jQuery slim (#1432) Nov 18, 2017
.editorconfig Changed to use 2 instead of 4 spaces Mar 2, 2016
.eslintrc.json chore(.eslintrc): reconfigure eslint Aug 7, 2017
.gitattributes chore(.gitattributes): add auto for text Feb 21, 2017
.gitignore feat: teach ReSpec to sort definition lists Nov 17, 2017
.jscsrc Fix(jscs): esnext rule was removed from 3.0 Apr 15, 2016
.jshintrc chore(deps): move dependencies to js/deps (closes #633) Jun 17, 2016
.npmignore refactor(copydeps): convert to nodejs script (closes #954) (#957) Nov 1, 2016
.snyk
.travis.yml chore(.travis): adhere to Node LTS Nov 2, 2017
.vscode chore(.vscode): add Visual Studio config Jul 5, 2017
CHANGELOG.md chore(CHANGELOG): regenerate Oct 9, 2017
CODE_OF_CONDUCT.md docs: http -> https (#1190) Apr 30, 2017
LICENSE.md chore(LICENSE): add LICENSE.md file (closes #1317) Jul 17, 2017
README.md chore(Greenkeeper): initial (#1378) Sep 7, 2017
appveyor.yml Chore(appveyor): Bump node version to 6.2 May 20, 2016
karma.conf.js chore(.travis): use linux instead of MacOS (#1398) Oct 20, 2017
package.json
yarn.lock chore(yarn): update lock file Oct 23, 2017

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 note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.