A tool that helps you write web standards
JavaScript HTML CSS
Permalink
Failed to load latest commit information.
builds v8.7.1 Jan 18, 2017
examples chore(examples): remove obsolete respec-debug files Jan 3, 2017
js fix(core/link-to-dfn): clean up after deferred linking (#1048) Jan 18, 2017
src feat: enable data-cite on dfn (#1046) Jan 17, 2017
tests tests: run karma against build instead (#1049) Jan 18, 2017
tools chore(tools/respecDocWriter): wait for respecIsReady promise Jan 8, 2017
worker chore(respec-worker): add empty web worker Dec 22, 2016
.babelrc chore(.babelrc): don't list module in present (obsolete) Jan 5, 2017
.editorconfig Changed to use 2 instead of 4 spaces Mar 2, 2016
.gitignore chore(.gitignore): ignore generated js/core/data-cite.js Jan 9, 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 fix: package.json & .snyk to reduce vulnerabilities Jun 23, 2016
.travis.yml chore(.travis.yml): build before testing Jan 5, 2017
CHANGELOG.md chore(CHANGELOG): regenerate Jan 16, 2017
CODE_OF_CONDUCT.md Feat(CODE_OF_CONDUCT): Add CoC to project Jun 26, 2016
README.md docs: add snyk badge Oct 12, 2016
appveyor.yml Chore(appveyor): Bump node version to 6.2 May 20, 2016
karma.conf.js tests: run karma against build instead (#1049) Jan 18, 2017
package.json chore(package): update snyk to version 1.24.6 (#1056) Jan 23, 2017
yarn.lock chore(yarn): update deps Dec 23, 2016

README.md

ReSpec

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 speref.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.