css-markdown

0.2.0 • Public • Published

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>

Package Sidebar

Install

npm i css-markdown

Weekly Downloads

3

Version

0.2.0

License

none

Last publish

Collaborators

  • mlmorg