Skip to content

w3c-ccg/markdown-to-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-to-spec

Markdown to spec template.

This lets you write your specs in markdown, or technically bikeshed -- a markdown document, with special extensions understood by the bikeshed tool. The bikeshed tool is run on-commit via the spec-prod github action, generating the familiar "spec looking" ReSpec format. ReSpec is just html with a javascript ReSpec library.

Get started

  1. Select "Use this template" and choose your repository

Select template image

  1. Go to Settings > Github Pages, and select gh-pages branch.

Select gh-pages branch image

Write your spec

Start editing your spec (note .bs file extension). The github action runs on commit to automatically convert to respec/html, via bikeshed.

Learn more about bikeshed