ramda.github.io/docs/index.html.handlebars at 245cd02ec5589e3cd8ff85619489a3e648e26700 · ramda/ramda.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!DOCTYPE html>
<html class="docs-page">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Ramda Documentation</title>
    <link rel="stylesheet" type="text/css" href="../style.css">
</head>
<body>
    <input type="checkbox" id="open-nav">
    <header class="navbar navbar-fixed-top navbar-inverse container-fluid">
        <div class="navbar-header">
            <label class="open-nav" for="open-nav"></label>
            <a class="navbar-brand" href="/">
                <strong>Ramda</strong>
                <span class="version">v{{version}}</span>
            </a>
        </div>
        <div class="navbar-left">
            <ul class="nav navbar-nav">
                <li><a href="..">Home</a></li>
                <li class="active"><a href="#">Documentation</a></li>
                <li><a href="/repl?v={{version}}">Try Ramda</a></li>
                <li><a href="https://github.com/ramda/ramda">GitHub</a></li>
            </ul>
        </div>
    </header>
    <aside class="sidebar container-fluid">
        <div class="form-group has-feedback filter">
            <input class="form-control"
                   tabindex="1"
                   id="name-filter"
                   placeholder="Filter"
                   type="text"
                   data-bind="textInput: filter"
                   autofocus
            >
            <span class="form-control-feedback">
                <span class="glyphicon glyphicon-search"></span>
            </span>
        </div>
        <ul class="nav nav-pills nav-stacked toc">
            {{#each docs}}
            <li class="func" data-name="{{name}}" data-category="{{category}}">
                <a href="#{{name}}">
                    {{name}}
                    <span data-category="{{category}}" class="label label-category pull-right"
                    >{{category}}</span>
                </a>
            </li>
            {{/each}}
        </ul>
    </aside>
    <main class="container-fluid">
        {{#each docs}}
        <section class="card" id="{{name}}">
            <h2>
                <a tabindex="2" class="name" href="#{{name}}">{{name}}</a>
                <span class="pull-right">
                        <span class="label label-category">{{category}}</span>
                        <a target="_blank" title="View source on GitHub" href="https://github.com/ramda/ramda/tree/v{{../version}}/src/{{name}}.js"><small class="glyphicon glyphicon-new-window"></small></a>
                </span>
            </h2>

            {{#if deprecated}}
            <div class="deprecated">
                Deprecated {{deprecated}}
            </div>
            {{/if}}

            {{#each sigs}}
            <div><code>{{this}}</code></div>
            {{/each}}

            {{#each typedefns}}
            <div><code>{{this}}</code></div>
            {{/each}}

            {{#if returns.type}}
            <div class="params" data-expanded="false">
                <a href="#expand" class="toggle-params">Parameters</a>
                <div class="details panel panel-default">
                    <ul class="list-group">
                        {{#each params}}
                        <li class="list-group-item">
                            <span class="type">
                                {{#each type}}
                                {{this}}
                                {{#unless @last}} | {{/unless}}
                                {{/each}}
                            </span>
                            <span class="name">{{name}}</span>
                            <span class="description">{{{description}}}</span>
                        </li>
                        {{/each}}
                    </ul>
                    <div class="panel-body">
                        {{#with returns}}
                        <span class="returns">Returns</span>
                        <span class="type">{{type}}</span>
                        <span class="description">{{{description}}}</span>
                        {{/with}}
                    </div>
                </div>
            </div>
            {{/if}}

            {{#if since}}
            <p><small>Added in {{since}}</small></p>
            {{/if}}

            <div class="description">{{{description}}}</div>

            {{#if aka}}
            <div class="aka">
                Known in other languages or libraries as
                {{#each aka}}
                {{#unless @first}}{{#unless @last}}{{else}} or{{/unless}}{{/unless}}<code>{{this}}</code>{{#unless @last}},{{else}}.{{/unless}}
                {{/each}}
            </div>
            {{/if}}

            {{#if see}}
            <div class="see">
                See also
                {{#each see}}
                <a href="#{{this}}">{{this}}</a>{{#unless @last}},{{else}}.{{/unless}}
                {{/each}}
            </div>
            {{/if}}

            {{#if example}}
	    <pre><button class="try-repl" data-ramda-version="{{@root.version}}">Try in REPL</button><code class="hljs javascript">{{{example}}}</code></pre>
            {{/if}}
        </section>
        {{/each}}
    </main>
    <script src="dist/ramda.js"></script>
    <script src="main.js"></script>
</body>
</html>