Bikeshed, a spec preprocessor
Bikeshed is a pre-processor for spec documents, turning a source document (containing only the actual spec content, plus several shorthands for linking to terms and other things) into a final spec document, with appropriate boilerplate, bibliography, indexes, etc all filled in. It's used on specs for CSS and many other W3C working groups, WHATWG, the C++ standards committee, and elsewhere!
The processor can be easily installed and run locally (requiring no network access unless you're updating), or accessed as a CGI without any installation at all: https://api.csswg.org/bikeshed/
A short overview of some of Bikeshed's features:
- automatic linking of terms to their definitions based on text, so you can simple write
Use <a>some term</a> to...and have it automatically link to the<dfn>some term</dfn>elsewhere in the document, or in another spec entirely! - automatic id generation for headings and definitions, based on their text.
- textual shortcuts for autolinks: [[FOO]] for bibliography entries, <<foo>> for grammar productions, 'foo' for CSS property names, {{foo}} for IDL terms, and more.
- boilerplate generation, both wholesale and piecemeal.
- Bikeshed-flavored Markdown, a slight variant that is extra-friendly to intermixing with normal HTML. (Besides the few intentional divergences, compliance with CommonMark is expected.)
- a compact syntax for writing property-definition tables.
- automatic whitespace-prefix stripping from
<pre>contents, so the contents can be indented properly in your HTML. - automatic IDL processing and syntax-checking for
<pre class=idl>contents, so you don't have to mark up every single significant term yourself. - automatic generation of railroad diagrams from
<pre class='railroad'>contents.
Documentation Sections
The full Bikeshed documentation is generated by Bikeshed and accessible here.
Note About Fatal Errors
Bikeshed generates "fatal errors" for lots of things that it wants you to fix,
but generally recovers gracefully from them anyway.
If you're getting a fatal error,
but don't have time to fix it and just need a spec right now,
you can force Bikeshed to generate anyway with the -f flag, like: bikeshed -f spec.
This is also sometimes useful when converting a spec to Bikeshed for the first time,
so you can see all the errors at once and fix them in whatever order is easiest,
rather than having to deal with them one-by-one with no idea when they'll end.
(You may also want to silence the warnings in this case,
to reduce visual noise until you've gotten it at least building successfully.
Use bikeshed -qf spec.)
Bikeshed File Extension
The preferred file extensions for Bikeshed source files is bs, like index.bs.
Bikeshed will automatically recognize *.bs files in the folder it's run in,
and assume that you want an output file of the same name with a .html extension.
The repository also contains a syntax highlighting script for Bikeshed source files.
(Bikeshed also recognizes files with *.src.html for backwards compatibility with older CSS specs,
though most such specs have switched their source file extensions to .bs now.
Using .src.html in most text editors will display the file with HTML source formatting,
which isn't generally what you want.)
License
This document and all associated files in the github project are licensed under CC0 