cm

css-markdown

Extract markdown comments in your css

Showing:

Popularity

Downloads/wk

1

GitHub Stars

4

Maintenance

Last Commit

7yrs ago

Contributors

2

Package

Dependencies

1

Size (min+gzip)

0.3KB

License

Type Definitions

Tree-Shakeable

No?

Categories

Readme

css-markdown Build Status

Extract markdown comments in your css.

Usage

Mark up your css comments with markdown, specifying its type with a /*md, /*markdown, or /*doc comment prefix:

/*md
# Some Floats

These float elements left or right!

```html
<div class="float--left">Floated left</div>
<div class="float--right">Floated right</div>
\```
*/
.float--left { float: left; }
.float--right { float: right; }

Then run the css-markdown command:

css-markdown floats.css > floats.md

floats.md will now contain:

# Some Floats

These float elements left or right!

```html
<div class="float--left">Floated left</div>
<div class="float--right">Floated right</div>

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100