A tool for creating technical documents and web standards.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Sid Vishnoi 5a3c14de89
chore: update prettier, style changes (#2800)
3 years ago
.github chore(ci): skip if message contains `ci skip` (#2671) 3 years ago
assets fix(assets/wwebidl.css): fix color contrast in IDL header (#2787) 3 years ago
builds v25.4.2 3 years ago
examples chore: move profiles to own folder (#2589) 3 years ago
js refactor(src/import-maps): use marked es module (#2633) 3 years ago
profiles feat(core/a11y): add axe-core integration (#2779) 3 years ago
src chore: update prettier, style changes (#2800) 3 years ago
tests chore: update prettier, style changes (#2800) 3 years ago
tools chore: update prettier, style changes (#2800) 3 years ago
worker fix: use external hljs bundle (#2162) 4 years ago
.editorconfig Changed to use 2 instead of 4 spaces 7 years ago
.eslintignore refactor: remove hljs config from profile (#2201) 4 years ago
.eslintrc.json refactor: force extensions for imports (#2555) 3 years ago
.gitignore fix(core/markdown): retry using reindent() instead (#2715) 3 years ago
.npmignore chore(.npmignore): ignore .vs dir 4 years ago
.snyk fix: .snyk to reduce vulnerabilities (#2533) 3 years ago
.vscode chore(.vscode): add Visual Studio config 5 years ago
CHANGELOG.md chore(CHANGELOG): regenerated 3 years ago
CODE_OF_CONDUCT.md docs: http -> https (#1190) 6 years ago
CONTRIBUTING.md Create CONTRIBUTING.md 5 years ago
LICENSE chore(LICENSE): Update text to 2015 version (#2742) 3 years ago
README.md docs(README): Add GitHub CI badge (#2576) 3 years ago
karma.conf.js chore: update prettier, style changes (#2800) 3 years ago
package-lock.json chore: update prettier, style changes (#2800) 3 years ago
package.json chore: update prettier, style changes (#2800) 3 years ago
serve.json chore(server): don't clear file extensions 4 years ago

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]