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

Select “Use this template” and choose your repository

Select template image

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