A tool for creating technical documents and web standards.
Go to file
Marcos Cáceres f0fa2bf752
refactor: move l10n strings to sotd template (#4013)
2022-02-08 17:49:05 +11:00
.github chore(ci/codeql-analysis): ignore builds (#3985) 2022-02-02 15:06:21 +05:30
.vscode chore: gitignore vscode settings (#3286) 2021-02-03 19:33:41 +05:30
builds v29.0.6 2022-02-07 14:15:46 +11:00
examples docs(examples/basic): silence priv/sec error (#4008) 2022-02-07 19:55:47 +11:00
js/deps chore(deps-dev): use updated rollup plugins (#3392) 2021-03-22 11:53:32 +11:00
profiles refactor: move l10n strings to sotd template (#4013) 2022-02-08 17:49:05 +11:00
src refactor: move l10n strings to sotd template (#4013) 2022-02-08 17:49:05 +11:00
tests fix: misaligned section markers (#4006) 2022-02-08 17:48:45 +11:00
tools BREAKING CHANGE: switch to Node 16 (LTS) + update deps (#3846) 2021-11-08 10:52:35 +11:00
worker refactor: build respec-highlight alongside respec-worker (#3390) 2021-03-22 15:14:14 +05:30
.editorconfig Changed to use 2 instead of 4 spaces 2016-03-02 11:44:56 +11:00
.eslintrc.json chore: remove unused files, config and packges (#3400) 2021-03-24 09:08:08 +11:00
.gitignore chore: gitignore vscode settings (#3286) 2021-02-03 19:33:41 +05:30
CHANGELOG.md chore(CHANGELOG): regenerate (#3607) 2021-06-15 23:38:32 +05:30
CODE_OF_CONDUCT.md chore(CODE_OF_CONDUCT): update enforcement contacts (#2802) 2020-03-23 12:27:14 +05:30
CONTRIBUTING.md Create CONTRIBUTING.md 2018-03-07 13:17:40 +11:00
LICENSE chore(LICENSE): Update text to 2015 version (#2742) 2020-02-07 15:55:22 +11:00
README.md chore: remove snyk (#3299) 2021-02-15 19:23:39 +05:30
SECURITY.md Create SECURITY.md 2022-01-31 13:05:14 +11:00
package-lock.json chore(deps-dev): bump rollup from 2.66.1 to 2.67.1 (#4012) 2022-02-08 11:33:11 +11:00
package.json chore(deps-dev): bump rollup from 2.66.1 to 2.67.1 (#4012) 2022-02-08 11:33:11 +11:00
serve.json chore(server): don't clear file extensions 2018-10-04 00:46:51 +10:00

README.md

ReSpec

Backers on Open Collective Sponsors on Open Collective Build Status Website status

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]