|
Local: Create
|
bikeshed spec
filename.bs : creates the HTML from the Bikeshed file |
|
Local: Auto-Update
|
bikeshed watch
filename.bs : creates the HTML from the Bikeshed file, and keeps watching the Bikeshed file for changes, automatically generating new HTML when the Bikeshed file changes |
|
Local: Template
|
bikeshed template : creates an empty template for starting a new Bikeshed project
|
|
Online: Create
|
|
|
Online: View Errors
|
curl https://api.csswg.org/bikeshed/ -F file=@
filename.bs -F output=err |
|
Online: Issue List
|
|
Documentation
|
|
|
#, ##, ###
|
<h1>, <h2>, <h3>
|
|
*
|
Unordered list. Indent with 4 spaces to include sub-list elements (tables, blockquotes, code examples, etc.)
|
|
1.
|
Ordered list. Indent with 4 spaces to include sub-list elements (tables, blockquotes, code examples, etc.)
|
|
>
|
Blockquote
|
|
\n\n
|
New paragraph (hit enter twice)
|
|
A link to a website
|
|
|
Insert image inline
|
|
|
*word word word*
|
Bold words
|
|
_word word word_
|
Underlined words
|
|
**word word word**
|
Strong words
|
|
__word word word__
|
Double underlined words
|
|
Documentation
|
|
|
Title:
|
The title of the specification. Will typically be inserted as a <h1> at the top of the document (unless the boilerplate has been changed).
|
|
Status:
|
Status of the document. e.g.
ED = Editor's Draft, WD = Working Draft, etc. Is based on the statuses for the Group |
|
Group:
|
The group / organization issuing the specification. e.g.
w3c, iso, fido, etc. |
|
ED:
|
URL pointing to the latest editor's draft
|
|
URL:
|
The URL for the specification
|
|
Short Name:
|
A short name of the spec, such as
css-lists or webauthn |
|
Editor:
|
The name of the person that is an editor for the spec. May have multiple editors, one per line. Format is:
Adam Powers, FIDO https://fidoalliance.org, email@fidoalliance.org |
|
Abstract:
|
A paragraph about this specification
|
|
Text Macro:
|
Defines a custom text macro
|
|
Documentation
|
|
|
Examples
|
|
|
header.include
|
The HTML for the header of the document
|
|
header-ED.include
|
The HTML for the header, when the status of the specification is
ED. Works for any statuses defined for the Group, and for any boilerplate where the name ends in -STATUS (e.g. -ED, -WD) |
|
footer.include
|
The HTML for the footer of the document
|
|
copyright.include
|
The copyright statement
|
|
logo.include
|
The HTML for the logo to be used, by default on the top right of the specification
|
|
Main Repo
|
|
|
Online Version
|
|
|
Install Locally
|
|
|
Quick Start
|
|
|
Docs
|
|
Documentation
|
|
|
## heading {#link-name}
|
Creates a new <h2> that is linkable by
link-name |
|
[[foo]]
|
A non-normative reference to the SpecRef entry
foo |
|
[[!foo]]
|
A normative reference to the SpecRef entry
foo |
|
A reference to the section in the local document named
foo |
|
|
[[foo#bar]]
|
A reference to section
bar of spec foo. The spec foo must be part of Bikeshed's autolinking database. |
|
[[spec/page#id]]
|
A reference to section
bar on page of spec foo. The spec foo must be part of Bikeshed's autolinking database. |
|
[[spec/page]]
|
A reference to section to
page of spec foo. The spec foo must be part of Bikeshed's autolinking database. |
|
{{foo}}
|
A reference to the IDL entry for
foo |
|
'foo'
|
Link to a property or descriptor named
foo |
|
<dfn>term</dfn>
|
A definition for
term |
|
[=foo=]
|
Link to definition of
foo |
|
Issue:
|
Adds the text that follows as a new issue with the specification. Will appear in a box and be added to the issue list.
|
|
Note:
|
Adds the text that follows as a note to the specification
|
|
Example:
|
Adds the text that follows as an example
|
|
Advisement:
|
Adds the text that follows as an advisement
|
|
Assertion:
|
Adds the text that follows as an assertion
|
|
class="note"
|
Same as
Note: |
|
class="issue"
|
Same as
Issue: |
|
class="idl"
|
Defines an IDL block
|
|
<pre class="highlight">
|
Defines pre-formatted text highlighted as code
|
|
line-highlight="2-4, 6"
|
Add to a
highlight class to emphasize specific lines of code |
|
line-numbers
|
Add to a
highlight class to add line numbers to the code |
|
Documentation
|
|
|
[TITLE]
|
gives the spec’s full title, as extracted from either the H1 or the spec metadata
|
|
[SHORTNAME]
|
gives the document’s shortname, like "css-cascade"
|
|
[VSHORTNAME]
|
gives the "versioned" shortname, like "css-cascade-3"
|
|
[STATUS]
|
gives the spec’s status
|
|
[LONGSTATUS]
|
gives a long form of the spec’s status, so "ED" becomes "Editor’s Draft", for example
|
|
[STATUSTEXT]
|
gives an additional status text snippet
|
|
[LATEST]
|
gives the link to the undated /TR link, if it exists
|
|
[VERSION]
|
gives the link to the ED, if the spec is an ED, and otherwise constructs a dated /TR link from today’s date
|
|
[ABSTRACT]
|
gives the document’s abstract
|
|
[YEAR]
|
gives the current year
|
|
[DATE]
|
gives a human-readable date
|
|
[CDATE]
|
gives a compact date in the format "YYYYMMDD"
|
|
[ISODATE]
|
gives a compact date in iso format "YYYY-MM-DD"
|
|
[LOGO]
|
gives the url of the spec’s logo
|
|
[REPOSITORY]
|
gives the name of the VCS repository the spec is located in; this is currently only filled when the spec source is in a GitHub repository
|
No comments yet.
Cheatography n. The art of mapping complex subjects into clear, instantly navigable reference guides.
