A tool for creating technical documents and web standards
JavaScript HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
builds v22.5.0 Aug 16, 2018
examples Fix closing heading tag in starter.html (#1763) Jul 21, 2018
js fix(core/webidl): various IDL fixes (#1792) Aug 7, 2018
src feat(core/xref): support inline IDL (#1765) Aug 16, 2018
tests feat(core/xref): support inline IDL (#1765) Aug 16, 2018
tools Mark deps/domReady as deprecated (#1797) Aug 8, 2018
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 refactor: remove `var` (#1784) Jul 30, 2018
.gitignore chore(.gitignore): use globs (#1518) Feb 19, 2018
.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 chore(.npmignore): ignore .vs dir Jun 26, 2018
.snyk fix: package.json & .snyk to reduce vulnerabilities Oct 26, 2017
.travis.yml Force eslint (#1777) Jul 28, 2018
.vscode chore(.vscode): add Visual Studio config Jul 5, 2017
CHANGELOG.md chore(CHANGELOG): regenerate Jun 26, 2018
CODE_OF_CONDUCT.md docs: http -> https (#1190) Apr 30, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Mar 7, 2018
ISSUE_TEMPLATE.md docs(ISSUE_TEMPLATE): fix template Apr 23, 2018
LICENSE.md chore(LICENSE): add LICENSE.md file (closes #1317) Jul 17, 2017
README.md Docs: fix link to editor's guide Feb 13, 2018
karma.conf.js fix(templates/show-people): allow HTML for company field (#1790) Aug 1, 2018
package-lock.json v22.5.0 Aug 16, 2018
package.json fix(package): update marked to version 0.5.0 (#1802) Aug 17, 2018
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 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.