A tool for creating technical documents and web standards
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: move and remove redundant files (#1993) Jan 4, 2019
assets refactor(assests/issue-notes.css) removed redundant css (#2070) Feb 5, 2019
builds v24.3.4 Feb 21, 2019
examples docs(starter.html): fix markup (#1933) Dec 2, 2018
js fix: reindent only pre elements (#2082) Feb 7, 2019
src fix(core/structure): add nbsp after § (#2117) Feb 21, 2019
tests fix(core/structure): add nbsp after § (#2117) Feb 21, 2019
tools fix(tools/respecDocWriter): emit all errors and warnings (#2088) Feb 12, 2019
worker feat(respec-worker): dynamically load highlight.js languages (#1835) Oct 2, 2018
.babelrc chore(package): upgrade to Babel 7 (#1901) Nov 22, 2018
.editorconfig Changed to use 2 instead of 4 spaces Mar 2, 2016
.eslintrc.json style: apply spaced-comment eslint rule (#2080) Feb 7, 2019
.gitignore fix(core/github): link GitHub at-risk issues (#2000) Jan 5, 2019
.npmignore chore(.npmignore): ignore .vs dir Jun 26, 2018
.snyk fix: .snyk to reduce vulnerabilities (#2037) Jan 18, 2019
.travis.yml test: fix eslint not globbing correctly on linux (#2076) Feb 6, 2019
.vscode chore(.vscode): add Visual Studio config Jul 5, 2017
CHANGELOG.md chore(CHANGELOG): regenerated Jan 7, 2019
CODE_OF_CONDUCT.md docs: http -> https (#1190) Apr 30, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Mar 7, 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 refactor: put assets into /assets (#2007) Jan 8, 2019
package-lock.json v24.3.4 Feb 21, 2019
package.json v24.3.4 Feb 21, 2019
serve.json chore(server): don't clear file extensions Oct 3, 2018

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.