A tool for creating technical documents and web standards.
Go to file
Marcos Cáceres 53566d56eb chore(server): don't clear file extensions 2018-10-04 00:46:51 +10:00
builds v23.1.1 2018-10-03 17:48:21 +10:00
examples docs(examples): fixbasic example 2018-10-03 08:07:52 +10:00
js fix(profile-w3c-common): URL params no longer a depedency 2018-09-16 01:46:14 +10:00
src chore(core/webidl): prettier/eslint fixes 2018-10-03 07:53:39 +10:00
tests chore(utils-spec): prettier/eslint fixes 2018-10-03 07:54:19 +10:00
tools fix(tools/copydeps): dont copy URL params 2018-09-16 01:39:29 +10:00
worker feat(respec-worker): dynamically load highlight.js languages (#1835) 2018-10-02 21:22:26 +05:30
.babelrc BREAKING CHANGE: use jQuery slim (#1432) 2017-11-18 21:02:53 +11:00
.editorconfig Changed to use 2 instead of 4 spaces 2016-03-02 11:44:56 +11:00
.eslintrc.json refactor: remove `var` (#1784) 2018-07-30 17:59:04 +05:30
.gitignore chore(.gitignore): use globs (#1518) 2018-02-20 08:39:37 +09:00
.jscsrc Fix(jscs): esnext rule was removed from 3.0 2016-04-15 11:39:45 +10:00
.jshintrc chore(deps): move dependencies to js/deps (closes #633) 2016-06-17 18:20:18 +10:00
.npmignore chore(.npmignore): ignore .vs dir 2018-06-26 10:25:57 -04:00
.snyk fix: package.json & .snyk to reduce vulnerabilities 2017-10-27 10:07:47 +11:00
.travis.yml Force eslint (#1777) 2018-07-28 19:54:46 +09:00
.vscode chore(.vscode): add Visual Studio config 2017-07-05 15:44:34 +10:00
CHANGELOG.md chore(CHANGELOG): regenerate 2018-06-26 16:26:38 -04:00
CODE_OF_CONDUCT.md docs: http -> https (#1190) 2017-04-30 21:27:29 +10:00
CONTRIBUTING.md Create CONTRIBUTING.md 2018-03-07 13:17:40 +11:00
ISSUE_TEMPLATE.md docs(ISSUE_TEMPLATE): fix template 2018-04-23 14:59:04 +10:00
LICENSE.md chore(LICENSE): add LICENSE.md file (closes #1317) 2017-07-17 16:05:53 +10:00
README.md Docs: fix link to editor's guide 2018-02-13 17:53:14 +11:00
karma.conf.js feat(respec-worker): dynamically load highlight.js languages (#1835) 2018-10-02 21:22:26 +05:30
package-lock.json v23.1.1 2018-10-03 17:48:21 +10:00
package.json v23.1.1 2018-10-03 17:48:21 +10:00
serve.json chore(server): don't clear file extensions 2018-10-04 00:46:51 +10:00
yarn.lock chore(yarn): update lock file 2017-10-24 01:21:04 +11:00

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.