Closed pietermees closed 6 years ago
The most commonly used system seems to be Bikeshed. It's actively used by W3C and WHATWG for all their new HTML, DOM, CSS specs.
Main: https://github.com/tabatkins/bikeshed Documentation: https://tabatkins.github.io/bikeshed Example: https://github.com/whatwg/fetch
Another alternative is ReSpec. It's mostly used at the W3C.
Main: https://github.com/w3c/respec Documentation: https://github.com/w3c/respec/wiki Example: https://github.com/WICG/webusb/tree/gh-pages
A comparison between the two options, where both authors have contributed, can be found here: https://stackoverflow.com/questions/36531493/respec-vs-bikeshed-how-to-document-and-publish-a-standard-rest-api-interface-to
Opted to go for Bikeshed
Bikeshed
The most commonly used system seems to be Bikeshed. It's actively used by W3C and WHATWG for all their new HTML, DOM, CSS specs.
Main: https://github.com/tabatkins/bikeshed Documentation: https://tabatkins.github.io/bikeshed Example: https://github.com/whatwg/fetch
ReSpec
Another alternative is ReSpec. It's mostly used at the W3C.
Main: https://github.com/w3c/respec Documentation: https://github.com/w3c/respec/wiki Example: https://github.com/WICG/webusb/tree/gh-pages
Comparison
A comparison between the two options, where both authors have contributed, can be found here: https://stackoverflow.com/questions/36531493/respec-vs-bikeshed-how-to-document-and-publish-a-standard-rest-api-interface-to