sassdoc 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGELOG.md +0 -0
- data/LICENSE +18 -0
- data/README.md +168 -0
- data/bin/sassdoc +47 -0
- data/lib/sassdoc.rb +142 -0
- data/viewer/css/bootstrap.css +3990 -0
- data/viewer/css/sassdoc.css +100 -0
- data/viewer/img/spinner.gif +0 -0
- data/viewer/index.html +35 -0
- data/viewer/js/lib/dust.js +61 -0
- data/viewer/js/lib/jquery.js +4 -0
- data/viewer/js/lib/jquery.scrollto.js +11 -0
- data/viewer/js/lib/sassdoc.js +454 -0
- data/viewer/tmpl/nav.tmpl +17 -0
- data/viewer/tmpl/toc.tmpl +13 -0
- data/viewer/tmpl/view.tmpl +87 -0
- metadata +79 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<div class="navbar navbar-fixed-top">
|
|
2
|
+
<div class="navbar-inner">
|
|
3
|
+
<div class="container-fluid">
|
|
4
|
+
<div class="nav-collapse">
|
|
5
|
+
<ul class="nav">
|
|
6
|
+
<li class="category"><a href="#all" class="category all">ALL</a></li>
|
|
7
|
+
<li class="divider-vertical"></li>
|
|
8
|
+
{#toc}
|
|
9
|
+
<li class="category"><a href="#category:{category_clean}" class="category {category_clean}">{category}</a></li>
|
|
10
|
+
{/toc}
|
|
11
|
+
</ul>
|
|
12
|
+
</div>
|
|
13
|
+
<span class="toggles description-search"><a href="#toggle:search" class="label label-info search" title="search description as well as the method names">include description</a></span>
|
|
14
|
+
<input type="text" id="method-search" placeholder="search..."/>
|
|
15
|
+
</div>
|
|
16
|
+
</div>
|
|
17
|
+
</div>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<ul class="toc nav nav-list">
|
|
2
|
+
<li class="category"><a href="#all" class="nav-header category all">ALL</a></li>
|
|
3
|
+
{#toc}
|
|
4
|
+
<li class="category">
|
|
5
|
+
<a href="#category:{category_clean}" class="nav-header category {category_clean}">{category}</a>
|
|
6
|
+
{?methods}
|
|
7
|
+
{#methods}
|
|
8
|
+
<li class="method is-category-{category_clean} {#private} is-private{/private}{#mixin} is-mixin{/mixin}{#function} is-function{/function}"><a href="#method:{name}" class="method">{name}</a></li>
|
|
9
|
+
{/methods}
|
|
10
|
+
{/methods}
|
|
11
|
+
</li>
|
|
12
|
+
{/toc}
|
|
13
|
+
</ul>
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
<ul class="toggles">
|
|
2
|
+
<li><a href="#toggle:minimal" class="label minimal">minimal view</a></li>
|
|
3
|
+
</ul>
|
|
4
|
+
<ul class="methods">
|
|
5
|
+
{#methods}
|
|
6
|
+
<li id="{name}" class="well is-method is-source-{source_clean} is-category-{category_clean}{?private} is-private{/private}{?mixin} is-mixin{/mixin}{?function} is-function{/function}">
|
|
7
|
+
<h2 class="method-name"><a href="#method:{name}" class="method">{name}</a><span class="signature">( {signature} )</span>{?deprecated} <span class="badge badge-error">deprecated</span>{/deprecated}</h2>
|
|
8
|
+
{?overview}
|
|
9
|
+
<p class="overview">
|
|
10
|
+
{#overview}
|
|
11
|
+
{.}<br/>
|
|
12
|
+
{/overview}
|
|
13
|
+
</p>
|
|
14
|
+
{/overview}
|
|
15
|
+
<span class="toggles"><a href="#toggle:unminimize" class="unminimized label label-success">more details</a></span>
|
|
16
|
+
<div class="minimize">
|
|
17
|
+
{?param}
|
|
18
|
+
<h3>Parameters</h3>
|
|
19
|
+
<ul class="params">
|
|
20
|
+
{#param}
|
|
21
|
+
<li>
|
|
22
|
+
<span class="param badge badge-info" title="parameter name">{name}</span>
|
|
23
|
+
{?type}
|
|
24
|
+
<span class="type badge" title="parameter type">{type}</span>
|
|
25
|
+
{/type}
|
|
26
|
+
{?acceptable}
|
|
27
|
+
<span class="acceptable badge badge-success" title="acceptable values for {name}">{acceptable}</span>
|
|
28
|
+
{/acceptable}
|
|
29
|
+
{?optional}
|
|
30
|
+
<span class="optional badge badge-warning" title="{name} is optional">Optional</span>
|
|
31
|
+
{/optional}
|
|
32
|
+
<span class="description">{description|s}</span>
|
|
33
|
+
</li>
|
|
34
|
+
{/param}
|
|
35
|
+
</ul>
|
|
36
|
+
{/param}
|
|
37
|
+
{#return}
|
|
38
|
+
<h3>Returns</h3>
|
|
39
|
+
<div class="returns">
|
|
40
|
+
{?type}
|
|
41
|
+
<span class="type badge" title="return type">{type}</span>
|
|
42
|
+
<span class="description">{description|s}</span>
|
|
43
|
+
{:else}
|
|
44
|
+
<span class="description">{.|s}</span>
|
|
45
|
+
{/type}
|
|
46
|
+
</div>
|
|
47
|
+
{/return}
|
|
48
|
+
{?usage}
|
|
49
|
+
<h3>Example Usage</h3>
|
|
50
|
+
<pre class="examples prettyprint linenums">
|
|
51
|
+
<ol class="linenums">
|
|
52
|
+
{#usage}
|
|
53
|
+
<li>{.}</li>
|
|
54
|
+
{/usage}
|
|
55
|
+
</ol>
|
|
56
|
+
</pre>
|
|
57
|
+
{/usage}
|
|
58
|
+
{?hasReferences}
|
|
59
|
+
<h3>References</h3>
|
|
60
|
+
<ol class="references">
|
|
61
|
+
{#link}
|
|
62
|
+
<li><a href="{.}" target="_blank">{.}</a></li>
|
|
63
|
+
{/link}
|
|
64
|
+
{#see}
|
|
65
|
+
<li>see <a href="#method:{.}">{.}()</a></li>
|
|
66
|
+
{/see}
|
|
67
|
+
</ol>
|
|
68
|
+
{/hasReferences}
|
|
69
|
+
<div class="tags">
|
|
70
|
+
<a href="#category:{category_clean}" class="category label label-info" title="see other methods in {category}">{category}</a>
|
|
71
|
+
<a href="#source:{source_clean}{?linenum}:{linenum}{/linenum}" class="source label label-info" title="view source">{source}{?linenum}:{linenum}{/linenum}</a>
|
|
72
|
+
{?mixin}<span class="label" title="{name}() is a mixin">mixin</span>{/mixin}
|
|
73
|
+
{?function}<span class="label" title="{name}() is a function">function</span>{/function}
|
|
74
|
+
{?private}<span class="label" title="{name}() is private">private</span>{/private}
|
|
75
|
+
{#tags}<span class="label" title="{name}() is {.}">{.}</span>{/tags}
|
|
76
|
+
</div>
|
|
77
|
+
</div>
|
|
78
|
+
</li>
|
|
79
|
+
{/methods}
|
|
80
|
+
</ul>
|
|
81
|
+
<div class="index hero-unit">
|
|
82
|
+
<h1>{SASSDOC_TITLE}</h1>
|
|
83
|
+
<p>
|
|
84
|
+
Use the filters and navigation to explore the various mixins and functions available.
|
|
85
|
+
</p>
|
|
86
|
+
</div>
|
|
87
|
+
<div class="source-viewer"></div>
|
metadata
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: sassdoc
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.2
|
|
5
|
+
prerelease:
|
|
6
|
+
platform: ruby
|
|
7
|
+
authors:
|
|
8
|
+
- Eugene ONeill
|
|
9
|
+
- LinkedIn
|
|
10
|
+
autorequire:
|
|
11
|
+
bindir: bin
|
|
12
|
+
cert_chain: []
|
|
13
|
+
date: 2012-09-24 00:00:00.000000000 Z
|
|
14
|
+
dependencies:
|
|
15
|
+
- !ruby/object:Gem::Dependency
|
|
16
|
+
name: json
|
|
17
|
+
requirement: !ruby/object:Gem::Requirement
|
|
18
|
+
none: false
|
|
19
|
+
requirements:
|
|
20
|
+
- - ! '>='
|
|
21
|
+
- !ruby/object:Gem::Version
|
|
22
|
+
version: '0'
|
|
23
|
+
type: :runtime
|
|
24
|
+
prerelease: false
|
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
26
|
+
none: false
|
|
27
|
+
requirements:
|
|
28
|
+
- - ! '>='
|
|
29
|
+
- !ruby/object:Gem::Version
|
|
30
|
+
version: '0'
|
|
31
|
+
description: Documentation generator for Sass source code
|
|
32
|
+
email: oneill.eugene@gmail.com
|
|
33
|
+
executables:
|
|
34
|
+
- sassdoc
|
|
35
|
+
extensions: []
|
|
36
|
+
extra_rdoc_files: []
|
|
37
|
+
files:
|
|
38
|
+
- LICENSE
|
|
39
|
+
- README.md
|
|
40
|
+
- CHANGELOG.md
|
|
41
|
+
- bin/sassdoc
|
|
42
|
+
- lib/sassdoc.rb
|
|
43
|
+
- viewer/css/bootstrap.css
|
|
44
|
+
- viewer/css/sassdoc.css
|
|
45
|
+
- viewer/img/spinner.gif
|
|
46
|
+
- viewer/index.html
|
|
47
|
+
- viewer/js/lib/dust.js
|
|
48
|
+
- viewer/js/lib/jquery.js
|
|
49
|
+
- viewer/js/lib/jquery.scrollto.js
|
|
50
|
+
- viewer/js/lib/sassdoc.js
|
|
51
|
+
- viewer/tmpl/nav.tmpl
|
|
52
|
+
- viewer/tmpl/toc.tmpl
|
|
53
|
+
- viewer/tmpl/view.tmpl
|
|
54
|
+
homepage: https://github.com/eoneill/sassdoc/
|
|
55
|
+
licenses:
|
|
56
|
+
- Apache License (2.0)
|
|
57
|
+
post_install_message:
|
|
58
|
+
rdoc_options: []
|
|
59
|
+
require_paths:
|
|
60
|
+
- lib
|
|
61
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
62
|
+
none: false
|
|
63
|
+
requirements:
|
|
64
|
+
- - ! '>='
|
|
65
|
+
- !ruby/object:Gem::Version
|
|
66
|
+
version: '0'
|
|
67
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
68
|
+
none: false
|
|
69
|
+
requirements:
|
|
70
|
+
- - ! '>='
|
|
71
|
+
- !ruby/object:Gem::Version
|
|
72
|
+
version: '0'
|
|
73
|
+
requirements: []
|
|
74
|
+
rubyforge_project:
|
|
75
|
+
rubygems_version: 1.8.24
|
|
76
|
+
signing_key:
|
|
77
|
+
specification_version: 3
|
|
78
|
+
summary: code documentation for Sass
|
|
79
|
+
test_files: []
|