Properties: name, description, modifiers, section (numbered), experimental, deprecated, compatibility
Format: Custom
// ---- | |
// Sass (v3.3.0.rc.2) | |
// Compass (v1.0.0.alpha.17) | |
// ---- | |
@function global-function($name) { | |
@return "hello " + $name; | |
} |
// ---- | |
// Sass (v3.3.4) | |
// Compass (v1.0.0.alpha.18) | |
// ---- | |
// Hacking made easy | |
// --- | |
// A couple of Sass functions | |
// To ease the pain of dealing | |
// With special values for IE |
// ---- | |
// Sass (v3.3.5) | |
// Compass (v1.0.0.alpha.18) | |
// ---- | |
// Returns opposite direction | |
// Quite similar to the one from Compass | |
// Rely on Sass 3.3 but could easily be adapted to Sass 3.2 | |
// --- | |
// @param [list] $directions: list of directions |
// ---- | |
// Sass (v3.3.4) | |
// Compass (v1.0.0.alpha.18) | |
// ---- | |
// Hacking made easy | |
// --- | |
// A couple of Sass functions | |
// To ease the pain of dealing | |
// With special values for IE |
// ---- | |
// Sass (v3.3.7) | |
// Compass (v1.0.0.alpha.18) | |
// ---- | |
// Handle Errors | |
//@include handle-error(test param, {accepted types or strings as spaced list}, {optional custom message as string}); | |
@mixin handle-error($test, $testAgainst, $custom-message:null) { | |
$string-match: false; |
// ---- | |
// Sass (v3.3.8) | |
// Compass (v1.0.0.alpha.19) | |
// ---- | |
@function foo() { | |
@return @function bar() { | |
@return "bar"; | |
} | |
} |
Properties: name, description, modifiers, section (numbered), experimental, deprecated, compatibility
Format: Custom
This is the preposed syntax for a unifying stylesheet documenation syntax.
Stylesheet documentation and the living styleguides are a critical piece of the modern web developer's toolchain. The benefit of living styleguides reach far beyond the technical teams, into design, UX and product.
// ---- | |
// Sass (v3.3.14) | |
// Compass (v1.0.0.rc.1) | |
// ---- | |
$map: ('foo': 10, foo/bar/baz: bam) !global; | |
// $foo/bar/baz: bam; <- this is an error in sass | |
a { |
// ---- | |
// Sass (v3.3.14) | |
// Compass (v1.0.1) | |
// ---- | |
// Private API function | |
// --- | |
// @param {*} $a | |
// @param {*} $b | |
// @param {*} $c |