Setup

Can be installed locally on any system with Python: https://github.com/tabatkins/bikeshed/

Or can be used remotely, via web form or curl: https://api.csswg.org/bikeshed/

Running `bikeshed template > index.bs` outputs an empty doc with basic necessities set up for you.

TODO: Get together some good example documents showing off features in situ.

Markdown

<h2 id="foo">Some Section</h2>
<p>Here's some information:</p>
<ol>
	<li>One
	<li>Two
		<ul>
			<li>Two subpoint
			<li>and another
		</ul>
	<li>Three
</ol>
	

Markdown

Some Section {#foo}
===================

Here's some information:

1. One
2. Two
	* Two subpoint
	* and another
3. Three

Markdown

• Only "block" markdown by default - paragraphs, headings, lists, code blocks
• Inline markdown (bold, italics, code) can be opted into with Markup Shorthands: markdown yes

Pre Blocks

<section>
	<p>some text
	<div class=example>
		<pre>function foo() {
  return 4;
}</pre>
	</div>
</section>

Pre Blocks

<section>
	<p>some text
	<div class=example>
		<pre>
			function foo() {
				return 4;
			}
		</pre>
	</div>
</section>

Pre Blocks

• Automatically strips the common whitespace prefix from all lines, and removes the first/last linebreak.
• Converts any remaining line-initial tabs into 2-space indents, for consistent and convenient display regardless of CSS.
• If the <pre> or an ancestor has class=lang-FOO or highlight=FOO, automatically syntax-highlights. (Using the substantial library of highlighters supported by Pygments.) Preserves original markup too, so linking + highlighting works together.

XMP support

<div class=example>
	<pre>
		&lt;p>some example HTML
		&lt;ul>
			&lt;li>And some more
			&lt;li>and more
		&lt;/ul>
	</pre>
</div>

XMP support

<div class=example>
	<xmp>
		<p>some example HTML
		<ul>
			<li>And some more
			<li>and more
		</ul>
	</xmp>
</div>

XMP support

• XMP is little-known deprecated HTML element that presents its contents as literal text. No markup allowed.
• For validators, Bikeshed auto-converts this to <pre> (with properly-escaped content) in the output document.

Remote Issues

If in a GitHub repo, or if you have Repository metadata set up, can use "remote issues":

<p>Some text that has an issue.

Issue(36):

<p>Following text

Railroad Diagrams

Like JSON.org diagrams, useful for indicating syntax/grammars

<pre class=railroad>
T: \
Choice:
	N: not newline or hex digit
	Seq:
		Plus:
			N: hex digit
			C: 1-6 times
		Opt: skip
			N: whitespace
</pre>

Linking

Moving to official explanation...