search

speced / bikeshed

:bike: A preprocessor for anyone writing specifications that converts source files into actual specs.
https://speced.github.io/bikeshed
Creative Commons Zero v1.0 Universal
1.12k stars 200 forks source link

Having a numbered "References" section? #2943

Open nicolo-ribaudo opened 1 month ago

nicolo-ribaudo commented 1 month ago

We are trying to use Bikeshed for an Ecma spec, and Ecma requires that "References" is a numbered section at the beginning of the document:

  1. Scope
  2. Conformance
  3. References
  4. Terms and definitions
  5. ... the actual spec
  6. ... the actual spec
  7. ... the actual spec

Is it possible to make Bikeshed emit a number of "References"? So far we are using this workaround: https://github.com/tc39/source-map/pull/140/files#diff-3480119203f58f4ecf5c7b07ed2417f18ef132eb6364edcdc4fe5a6b7f0ba612R220-R234

tabatkins commented 2 weeks ago

It's not currently possible to do so; as you've found, Bikeshed has Opinions on what sort of heading the References section uses and where it goes.

However, it would be an easy fix to allow you to specify your own heading and have Bikeshed fill that section instead of generating its own.