Add missing documentation to mixins

This commit is contained in:
Ines Montani 2017-01-01 12:43:43 +01:00
parent e3d84572f2
commit 4acd026cb6

View File

@ -1,6 +1,7 @@
//- 💫 MIXINS > BASE //- 💫 MIXINS > BASE
//- Aside wrapper //- Aside wrapper
label - [string] aside label
mixin aside-wrapper(label) mixin aside-wrapper(label)
aside.c-aside aside.c-aside
@ -21,6 +22,10 @@ mixin date(input)
//- SVG from map //- SVG from map
file - [string] SVG file name in /assets/img/
name - [string] SVG symbol id
width - [integer] width in px
height - [integer] height in px (default: same as width)
mixin svg(file, name, width, height) mixin svg(file, name, width, height)
svg(aria-hidden="true" viewBox="0 0 #{width} #{height || width}" width=width height=(height || width))&attributes(attributes) svg(aria-hidden="true" viewBox="0 0 #{width} #{height || width}" width=width height=(height || width))&attributes(attributes)
@ -28,12 +33,15 @@ mixin svg(file, name, width, height)
//- Icon //- Icon
name - [string] icon name, should be SVG symbol ID
size - [integer] icon width and height (default: 20)
mixin icon(name, size) mixin icon(name, size)
+svg("icons", name, size || 20).o-icon&attributes(attributes) +svg("icons", name, size || 20).o-icon&attributes(attributes)
//- Pro/Con/Neutral icon //- Pro/Con/Neutral icon
icon - [string] "pro", "con" or "neutral" (default: "neutral")
mixin procon(icon) mixin procon(icon)
- colors = { pro: "green", con: "red" } - colors = { pro: "green", con: "red" }
@ -41,6 +49,7 @@ mixin procon(icon)
//- Headlines Helper Mixin //- Headlines Helper Mixin
level - [integer] 1, 2, 3, 4, or 5
mixin headline(level) mixin headline(level)
if level == 1 if level == 1
@ -65,6 +74,7 @@ mixin headline(level)
//- Permalink rendering //- Permalink rendering
id - [string] permalink ID used for link anchor
mixin permalink(id) mixin permalink(id)
if id if id
@ -77,6 +87,7 @@ mixin permalink(id)
//- Terminal-style code window //- Terminal-style code window
label - [string] title displayed in top bar of terminal window
mixin terminal(label) mixin terminal(label)
.x-terminal .x-terminal