Bikeshed Tools for VS Code

Build Status Latest Release Open Issues Pull Requests Last Commit Contributors Version

This VS Code extension enables spec developers to write, preview and build Bikeshed specifications without leaving the editor.

FEATURES

Syntax Highlighting
Makes .bs specs easier to read and less error-prone.
Snippets & Suggestions
Common metadata, boilerplate, and macros—available with a keystroke.
Hover Info
See explanations of Bikeshed macros and metadata without leaving your editor.
Build Command
Use the command palette (“Bikeshed: Build Spec”) to generate HTML from your Bikeshed source.
Live Preview (Experimental) Instantly view the generated HTML next to your source. Preview refreshes on save.
Error Feedback
Bikeshed warnings and errors appear in the VS Code output panel, so you never have to hunt in the terminal.

Install Python and Bikeshed
You must have Python installed (3.7+ recommended). Then open your terminal and run:

python3 -m pip install --upgrade bikeshed
bikeshed update

Configure Paths (if needed)
If Bikeshed isn’t globally available (e.g., you used a virtual environment), set the path in your VS Code settings (either via the Settings UI or .vscode/settings.json):

{
  "bikeshedTools.pythonPath": "/path/to/python",
  "bikeshedTools.bikeshedPath": "/path/to/bikeshed"
}

Leave either field blank to let the extension auto-detect.

Open or create a file with the .bs extension.
Add your <pre class="metadata"> block and start editing.
Use the command palette (Ctrl+Shift+P or Cmd+Shift+P) and run “Bikeshed: Build Spec” to build your document.
To see the live HTML preview, save your .bs file.

If Bikeshed or Python are not found, you’ll be prompted to select them on first use.
Bikeshed’s cache must be updated (run bikeshed update in your terminal) before first use.
Most issues can be solved by making sure Python and Bikeshed are up to date and available on your system PATH, or by setting the correct paths in your workspace settings.