Describe, document & validate your CSS framework with the spec toolkit.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
bin
examples
lib
templates
test
.gitignore
README.md
package.json
yarn.lock

README.md

Spec

Spec is a CSS Framework specification toolkit.

It can:

  • specify a CSS framework requirements
  • generate its documentation
  • validate a DOM for its spec and guidelines conformance

Getting started

# install the spec `cli`:
npm install -g @codename/spec

# generate documentation for a spec
spec doc examples/mini-3.0.0.spec

# generate documentation using a custom template
spec doc examples/bulma-0.7.1.spec -t examples/bulma.pug

Features

Framework specification

Spec helps specify a CSS framework requirements and usage with the help of a .spec file that relies on the eno notation language, which is quite similar to TOML with an easier to apprehend modern syntax.

Documentation generation

TBD

Validation & conformance

TBD