Javadoc-like format to describe your styles (CSS, LESS, SASS etc.)

Format

StyleDoc format specification and essentials.

Documentor

Parser and showcase generator for documented styles.

Available for browser, npm, grunt, bower.

@section

Categories: css

Status: Partial

Assigns a number or ID for showcase section.

Optionally, can also assign section title (separated by whitespace(s)).

Handling in documentor

If set, is also used as section sorting criteria on showcase page.

If section title is omitted, block title or @base title is used instead.

Not implemented Multible docblocks having same @section are combined into a single showcase section.

Examples

Basic usage:

@section 2.3

Also set section title:

@section 2.3 Pressable buttons

See also