{"id":13401177,"url":"https://github.com/speced/bikeshed","last_synced_at":"2026-01-15T22:20:21.618Z","repository":{"id":7126514,"uuid":"8421800","full_name":"speced/bikeshed","owner":"speced","description":":bike: A preprocessor for anyone writing specifications that converts source files into actual specs.","archived":false,"fork":false,"pushed_at":"2025-05-05T20:52:41.000Z","size":667094,"stargazers_count":1183,"open_issues_count":463,"forks_count":202,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-05-09T00:03:45.672Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://speced.github.io/bikeshed","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speced.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-02-26T00:43:52.000Z","updated_at":"2025-05-05T07:20:16.000Z","dependencies_parsed_at":"2023-10-13T11:05:42.756Z","dependency_job_id":"2bd585ef-8a1a-4137-97ae-a8e7c7411187","html_url":"https://github.com/speced/bikeshed","commit_stats":{"total_commits":4548,"total_committers":134,"mean_commits":"33.940298507462686","dds":"0.22823218997361483","last_synced_commit":"d0bc3723a4f8ed6552f2fa10662c09dffb9abaac"},"previous_names":["tabatkins/bikeshed"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speced%2Fbikeshed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speced%2Fbikeshed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speced%2Fbikeshed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speced%2Fbikeshed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speced","download_url":"https://codeload.github.com/speced/bikeshed/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254036807,"owners_count":22003651,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:00:59.536Z","updated_at":"2026-01-15T22:20:21.574Z","avatar_url":"https://github.com/speced.png","language":"HTML","funding_links":[],"categories":["HTML","others"],"sub_categories":[],"readme":"Bikeshed, a spec preprocessor\n=============================\n\n\u003cimg src=\"https://raw.githubusercontent.com/speced/bikeshed/main/bikeshed.svg\" width=100 height=100 align=left\u003e\n\nBikeshed is a pre-processor for spec documents,\nturning a source document\n(containing only the actual spec content, plus several shorthands for linking to terms and other things)\ninto a final spec document,\nwith appropriate boilerplate, bibliography, indexes, etc all filled in.\nIt's used on specs for CSS and many other W3C working groups,\nWHATWG,\nthe C++ standards committee,\nand elsewhere!\n\n![CI](https://github.com/speced/bikeshed/workflows/CI/badge.svg)\n[![Gitter](https://img.shields.io/badge/Gitter-Join%20Chat%20↣-blue.svg)](https://gitter.im/tabatkins/bikeshed?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n[![Docs](https://img.shields.io/badge/docs-available-orange.svg)](https://speced.github.io/bikeshed)\n[![Release Notes](https://img.shields.io/badge/release-notes-purple.svg)](https://github.com/speced/bikeshed/issues/1773)\n\nThe processor can be easily [installed](https://speced.github.io/bikeshed/#installing) and run locally (requiring no\nnetwork access unless you're updating), or accessed as a CGI without any installation at all: \u003chttps://api.csswg.org/bikeshed/\u003e\n\nA short overview of some of Bikeshed's features:\n\n* [automatic linking](https://speced.github.io/bikeshed/#autolinking) of terms to their definitions based on text, so you can simple write `Use \u003ca\u003esome term\u003c/a\u003e to...` and have it automatically link to the `\u003cdfn\u003esome term\u003c/dfn\u003e` elsewhere in the document, or in another spec entirely!\n* [automatic id generation](https://speced.github.io/bikeshed/#id-gen) for headings and definitions, based on their text.\n* [textual shortcuts for autolinks](https://speced.github.io/bikeshed/#autolink-shortcuts): [[FOO]] for bibliography entries, \u0026lt;\u0026lt;foo\u003e\u003e for grammar productions, 'foo' for CSS property names, {{foo}} for IDL terms, and more.\n* [boilerplate generation](https://speced.github.io/bikeshed/#boilerplate), both wholesale and piecemeal.\n* [Bikeshed-flavored Markdown](https://speced.github.io/bikeshed/#markdown), a slight variant that is extra-friendly to intermixing with normal HTML. (Besides the few intentional divergences, compliance with [CommonMark](https://commonmark.org) is expected.)\n* a [compact syntax](https://speced.github.io/bikeshed/#table-expansion) for writing property-definition tables.\n* [automatic whitespace-prefix stripping](https://speced.github.io/bikeshed/#pre-whitespace-stripping) from `\u003cpre\u003e` contents, so the contents can be indented properly in your HTML.\n* [automatic IDL processing and syntax-checking](https://speced.github.io/bikeshed/#idl) for `\u003cpre class=idl\u003e` contents, so you don't have to mark up every single significant term yourself.\n* [automatic generation of railroad diagrams](https://speced.github.io/bikeshed/#railroad) from `\u003cpre class='railroad'\u003e` contents.\n\nDocumentation Sections\n----------------------\n\nThe full Bikeshed documentation is generated by Bikeshed and [accessible here](https://speced.github.io/bikeshed/).\n\nNote About Fatal Errors\n-----------------------\n\nBikeshed generates \"fatal errors\" for lots of things that it wants you to fix,\nbut generally recovers gracefully from them anyway.\nIf you're getting a fatal error,\nbut don't have time to fix it and just need a spec **right now**,\nyou can force Bikeshed to generate anyway with the `-f` flag, like: `bikeshed -f spec`.\n\nThis is also sometimes useful when converting a spec to Bikeshed for the first time,\nso you can see all the errors at once and fix them in whatever order is easiest,\nrather than having to deal with them one-by-one with no idea when they'll end.\n(You may also want to silence the warnings in this case,\nto reduce visual noise until you've gotten it at least building successfully.\nUse `bikeshed -qf spec`.)\n\nBikeshed File Extension\n-----------------------\n\nThe preferred file extensions for Bikeshed source files is `bs`, like `index.bs`.\nBikeshed will automatically recognize `*.bs` files in the folder it's run in,\nand assume that you want an output file of the same name with a `.html` extension.\nThe repository also contains a syntax highlighting script for Bikeshed source files.\n\n(Bikeshed also recognizes files with `*.src.html` for backwards compatibility with older CSS specs,\nthough most such specs have switched their source file extensions to `.bs` now.\nUsing `.src.html` in most text editors will display the file with HTML source formatting,\nwhich isn't generally what you want.)\n\nLicense\n-------\n\nThis document and all associated files in the github project are licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0/) ![](https://licensebuttons.net/p/zero/1.0/80x15.png).\nThis means you can reuse, remix, or otherwise appropriate this project for your own use **without restriction**.\n(The actual legal meaning can be found at the above link.)\nDon't ask me for permission to use any part of this project, **just use it**.\nI would appreciate attribution, but that is not required by the license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeced%2Fbikeshed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeced%2Fbikeshed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeced%2Fbikeshed/lists"}