Skip to content

Commit 40ac38a

Browse files
author
Kaelig
committed
Compile SassDoc
1 parent 64cf441 commit 40ac38a

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

‎index.scss

+4-2
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@
1111
/// @type String
1212
$app-version: '1.0.0' !default;
1313

14-
/// Mode:
15-
/// - `disabled`: output all code, even if deprecated
14+
/// Deprecation mode
15+
///
16+
/// ### Available modes:
17+
/// - `disabled`: output all the code, even if deprecated
1618
/// - `silent`: disable all warnings but don't output deprecated code
1719
/// - `verbose`: show all warnings, even for code that is *about* to be deprecated
1820
/// - `sensible` (default): output warnings when deprecated code is detected

‎sassdoc/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!doctype html><html lang="en"><head><meta charset="utf-8"><title>Sass Deprecate</title><link rel="stylesheet" href="assets/css/main.css"><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,500,700" rel="stylesheet" type="text/css"><meta name="viewport" content="width=device-width"><meta content="IE=edge, chrome=1" http-equiv="X-UA-Compatible"><!-- Open Graph tags --><meta property="og:title" content="Sass Deprecate - SassDoc"><meta property="og:type" content="website"><meta property="og:description" content="<p>deprecate() is a Sass mixin that helps managing code deprecation.</p>
2-
"><!-- Thanks to Sass-lang.com for the icons --><link href="assets/images/favicon.png" rel="shortcut icon"></head><body><aside class="sidebar" role="nav"><div class="sidebar__header"><h1 class="sidebar__title"><a href="https://github.com/salesforce-ux/sass-deprecate">Sass Deprecate</a></h1></div><div class="sidebar__body"><button type="button" class="btn-toggle js-btn-toggle" data-alt="Open all">Close all</button><p class="sidebar__item sidebar__item--heading" data-slug="undefined"><a href="#undefined">General</a></p><div><p class="sidebar__item sidebar__item--sub-heading" data-slug="undefined-variable"><a href="#undefined-variable">variables</a></p><ul class="list-unstyled"><li class="sidebar__item sassdoc__item" data-name="app-version" data-type="variable"><a href="#undefined-variable-app-version">app-version</a></li><li class="sidebar__item sassdoc__item" data-name="deprecate-mode" data-type="variable"><a href="#undefined-variable-deprecate-mode">deprecate-mode</a></li></ul><p class="sidebar__item sidebar__item--sub-heading" data-slug="undefined-mixin"><a href="#undefined-mixin">mixins</a></p><ul class="list-unstyled"><li class="sidebar__item sassdoc__item" data-name="deprecate" data-type="mixin"><a href="#undefined-mixin-deprecate">deprecate</a></li></ul></div></div></aside><article class="main" role="main"><header class="header" role="banner"><div class="container"><div class="sassdoc__searchbar searchbar"><label for="js-search-input" class="visually-hidden">Search</label><div class="searchbar__form" id="js-search"><input name="search" type="search" class="searchbar__field" autocomplete="off" autofocus id="js-search-input" placeholder="Search"><ul class="searchbar__suggestions" id="js-search-suggestions"></ul></div></div></div></header><section class="main__section"><h1 class="main__heading" id="undefined"><div class="container">General</div></h1><section class="main__sub-section" id="undefined-variable"><h2 class="main__heading--secondary"><div class="container">variables</div></h2><section class="main__item container item" id="undefined-variable-app-version"><h3 class="item__heading"><a class="item__name" href="#variable-app-version">app-version</a></h3><div class="item__code-wrapper"><pre class="item__code language-scss"><code>$app-version: &#39;1.0.0&#39; !default;</code></pre></div><h3 class="item__sub-heading">Description</h3><div class="item__description"><p>Application version</p></div><h3 class="item__sub-heading">Type</h3><p><code>String</code></p><h3 class="item__sub-heading">Used by</h3><ul class="list-unstyled"><li><span class="item__cross-type">[mixin]</span> <a href="#mixin-deprecate"><code>deprecate</code></a></li></ul></section><section class="main__item container item" id="undefined-variable-deprecate-mode"><h3 class="item__heading"><a class="item__name" href="#variable-deprecate-mode">deprecate-mode</a></h3><div class="item__code-wrapper"><pre class="item__code language-scss"><code>$deprecate-mode: &#39;sensible&#39; !default;</code></pre></div><h3 class="item__sub-heading">Description</h3><div class="item__description"><p>Mode:</p><ul><li><code>disabled</code>: output all code, even if deprecated</li><li><code>silent</code>: disable all warnings but don&#39;t output deprecated code</li><li><code>verbose</code>: show all warnings, even for code that is <em>about</em> to be deprecated</li><li><code>sensible</code> (default): output warnings when deprecated code is detected</li><li><code>fail</code>: prevent compilation when deprecated code is found</li></ul></div><h3 class="item__sub-heading">Type</h3><p><code>String</code></p><h3 class="item__sub-heading">Used by</h3><ul class="list-unstyled"><li><span class="item__cross-type">[mixin]</span> <a href="#mixin-deprecate"><code>deprecate</code></a></li></ul></section></section><section class="main__sub-section" id="undefined-mixin"><h2 class="main__heading--secondary"><div class="container">mixins</div></h2><section class="main__item container item" id="undefined-mixin-deprecate"><h3 class="item__heading"><a class="item__name" href="#mixin-deprecate">deprecate</a></h3><div class="item__code-wrapper"><pre class="item__code item__code--togglable language-scss" data-current-state="collapsed" data-expanded="@mixin deprecate($version, $message) {
2+
"><!-- Thanks to Sass-lang.com for the icons --><link href="assets/images/favicon.png" rel="shortcut icon"></head><body><aside class="sidebar" role="nav"><div class="sidebar__header"><h1 class="sidebar__title"><a href="https://github.com/salesforce-ux/sass-deprecate">Sass Deprecate</a></h1></div><div class="sidebar__body"><button type="button" class="btn-toggle js-btn-toggle" data-alt="Open all">Close all</button><p class="sidebar__item sidebar__item--heading" data-slug="undefined"><a href="#undefined">General</a></p><div><p class="sidebar__item sidebar__item--sub-heading" data-slug="undefined-variable"><a href="#undefined-variable">variables</a></p><ul class="list-unstyled"><li class="sidebar__item sassdoc__item" data-name="app-version" data-type="variable"><a href="#undefined-variable-app-version">app-version</a></li><li class="sidebar__item sassdoc__item" data-name="deprecate-mode" data-type="variable"><a href="#undefined-variable-deprecate-mode">deprecate-mode</a></li></ul><p class="sidebar__item sidebar__item--sub-heading" data-slug="undefined-mixin"><a href="#undefined-mixin">mixins</a></p><ul class="list-unstyled"><li class="sidebar__item sassdoc__item" data-name="deprecate" data-type="mixin"><a href="#undefined-mixin-deprecate">deprecate</a></li></ul></div></div></aside><article class="main" role="main"><header class="header" role="banner"><div class="container"><div class="sassdoc__searchbar searchbar"><label for="js-search-input" class="visually-hidden">Search</label><div class="searchbar__form" id="js-search"><input name="search" type="search" class="searchbar__field" autocomplete="off" autofocus id="js-search-input" placeholder="Search"><ul class="searchbar__suggestions" id="js-search-suggestions"></ul></div></div></div></header><section class="main__section"><h1 class="main__heading" id="undefined"><div class="container">General</div></h1><section class="main__sub-section" id="undefined-variable"><h2 class="main__heading--secondary"><div class="container">variables</div></h2><section class="main__item container item" id="undefined-variable-app-version"><h3 class="item__heading"><a class="item__name" href="#variable-app-version">app-version</a></h3><div class="item__code-wrapper"><pre class="item__code language-scss"><code>$app-version: &#39;1.0.0&#39; !default;</code></pre></div><h3 class="item__sub-heading">Description</h3><div class="item__description"><p>Application version</p></div><h3 class="item__sub-heading">Type</h3><p><code>String</code></p><h3 class="item__sub-heading">Used by</h3><ul class="list-unstyled"><li><span class="item__cross-type">[mixin]</span> <a href="#mixin-deprecate"><code>deprecate</code></a></li></ul></section><section class="main__item container item" id="undefined-variable-deprecate-mode"><h3 class="item__heading"><a class="item__name" href="#variable-deprecate-mode">deprecate-mode</a></h3><div class="item__code-wrapper"><pre class="item__code language-scss"><code>$deprecate-mode: &#39;sensible&#39; !default;</code></pre></div><h3 class="item__sub-heading">Description</h3><div class="item__description"><p>Deprecation mode</p><h3 id="available-modes-">Available modes:</h3><ul><li><code>disabled</code>: output all the code, even if deprecated</li><li><code>silent</code>: disable all warnings but don&#39;t output deprecated code</li><li><code>verbose</code>: show all warnings, even for code that is <em>about</em> to be deprecated</li><li><code>sensible</code> (default): output warnings when deprecated code is detected</li><li><code>fail</code>: prevent compilation when deprecated code is found</li></ul></div><h3 class="item__sub-heading">Type</h3><p><code>String</code></p><h3 class="item__sub-heading">Used by</h3><ul class="list-unstyled"><li><span class="item__cross-type">[mixin]</span> <a href="#mixin-deprecate"><code>deprecate</code></a></li></ul></section></section><section class="main__sub-section" id="undefined-mixin"><h2 class="main__heading--secondary"><div class="container">mixins</div></h2><section class="main__item container item" id="undefined-mixin-deprecate"><h3 class="item__heading"><a class="item__name" href="#mixin-deprecate">deprecate</a></h3><div class="item__code-wrapper"><pre class="item__code item__code--togglable language-scss" data-current-state="collapsed" data-expanded="@mixin deprecate($version, $message) {
33
@if (type-of($version) != &#39;string&#39;) {
44
@error &#39;The parameter passed to deprecate() must be a String. Good: deprecate(\&#39;0.1.0\&#39;) / Bad: deprecate(0.1.0).&#39;;
55
}

0 commit comments

Comments
 (0)