Skip to content
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(assets/respec2): wavy by default (#2418) Jul 13, 2019
builds v24.26.1 Jul 14, 2019
examples feat(core/webidl): enable validation (#2416) Jul 12, 2019
js fix(core/anchor-expander): clone nodes when expanding an anchor (#2326) May 4, 2019
src feat(core/webidl): enable validation (#2416) Jul 12, 2019
tests feat(core/webidl): enable validation (#2416) Jul 12, 2019
tools chore(package): update eslint to version 6.0.0 Jul 1, 2019
worker fix: use external hljs bundle (#2162) Mar 18, 2019
.babelrc refactor: add .js file extensions for imports/exports (#2237) Apr 9, 2019
.editorconfig Changed to use 2 instead of 4 spaces Mar 2, 2016
.eslintignore refactor: remove hljs config from profile (#2201) Mar 26, 2019
.eslintrc.json chore(package): update eslint to version 6.0.0 Jul 1, 2019
.gitignore feat(w3c): make a jQuery-less profile (w3c) (#2249) Apr 12, 2019
.npmignore chore(.npmignore): ignore .vs dir Jun 26, 2018
.snyk fix: .snyk, package.json & package-lock.json to reduce vulnerabilities ( Jul 4, 2019
.travis.yml test: add firefox to travis (#2277) Apr 15, 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(README): move to travis.com Jun 2, 2019
karma.conf.js chore(package): update eslint to version 6.0.0 Jul 1, 2019
package-lock.json chore(package): update webpack to version 4.36.1 (#2426) Jul 19, 2019
package.json chore(package): update webpack to version 4.36.1 (#2426) Jul 19, 2019
serve.json chore(server): don't clear file extensions Oct 3, 2018

README.md

ReSpec

Backers on Open Collective Sponsors on Open Collective 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.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

You can’t perform that action at this time.