Skip to content

Commit d2f4eab

Browse files
minajevsminajevs
committed
Added docs
1 parent f68e54c commit d2f4eab

File tree

14 files changed

+2129
-19
lines changed

14 files changed

+2129
-19
lines changed

‎README.MD

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,8 @@ mainStore.someAction('Dmitrijs')
278278
// mainStore.message is "Hello, Dmitrijs, you have 2 todos!"
279279
```
280280

281+
### Docs
282+
[📖 Read full api reference and docs by clicking here 📖](//google.com)
283+
281284
### TODO:
282285
* Documentation sections about what benefits does TypeScript gives
283-
* API docs (arguments, types, etc...)

‎docs/assets/css/main.css

Lines changed: 865 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/assets/css/main.css.map

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/images/icons.png

9.26 KB
Loading

‎docs/assets/images/[email protected]

27.1 KB
Loading

‎docs/assets/images/widgets.png

480 Bytes
Loading

‎docs/assets/images/[email protected]

855 Bytes
Loading

‎docs/assets/js/main.js

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/js/search.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/globals.html

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>react-concise-state</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="index.html" class="title">react-concise-state</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-only-exported" />
42+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
43+
</div>
44+
</div>
45+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
46+
</div>
47+
</div>
48+
</div>
49+
</div>
50+
<div class="tsd-page-title">
51+
<div class="container">
52+
<ul class="tsd-breadcrumb">
53+
<li>
54+
<a href="globals.html">Globals</a>
55+
</li>
56+
</ul>
57+
<h1> react-concise-state</h1>
58+
</div>
59+
</div>
60+
</header>
61+
<div class="container container-main">
62+
<div class="row">
63+
<div class="col-8 col-content">
64+
<section class="tsd-panel-group tsd-index-group">
65+
<h2>Index</h2>
66+
<section class="tsd-panel tsd-index-panel">
67+
<div class="tsd-index-content">
68+
<section class="tsd-index-section ">
69+
<h3>External modules</h3>
70+
<ul class="tsd-index-list">
71+
<li class="tsd-kind-external-module"><a href="modules/_index_.html" class="tsd-kind-icon">"index"</a></li>
72+
</ul>
73+
</section>
74+
</div>
75+
</section>
76+
</section>
77+
</div>
78+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
79+
<nav class="tsd-navigation primary">
80+
<ul>
81+
<li class="globals current ">
82+
<a href="globals.html"><em>Globals</em></a>
83+
</li>
84+
<li class=" tsd-kind-external-module">
85+
<a href="modules/_index_.html">"index"</a>
86+
</li>
87+
</ul>
88+
</nav>
89+
<nav class="tsd-navigation secondary menu-sticky">
90+
<ul class="before-current">
91+
</ul>
92+
</nav>
93+
</div>
94+
</div>
95+
</div>
96+
<footer class="with-border-bottom">
97+
<div class="container">
98+
<h2>Legend</h2>
99+
<div class="tsd-legend-group">
100+
<ul class="tsd-legend">
101+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
102+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
103+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
104+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
105+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
106+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
107+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
108+
</ul>
109+
<ul class="tsd-legend">
110+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
111+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
112+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
113+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
114+
</ul>
115+
<ul class="tsd-legend">
116+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
117+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
118+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
119+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
120+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
121+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
122+
</ul>
123+
<ul class="tsd-legend">
124+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
125+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
126+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
127+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
128+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
129+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
130+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
131+
</ul>
132+
<ul class="tsd-legend">
133+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
134+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
135+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
136+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
137+
</ul>
138+
<ul class="tsd-legend">
139+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
140+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
141+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
142+
</ul>
143+
<ul class="tsd-legend">
144+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
145+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
146+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
147+
</ul>
148+
<ul class="tsd-legend">
149+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
150+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
151+
</ul>
152+
</div>
153+
</div>
154+
</footer>
155+
<div class="container tsd-generator">
156+
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
157+
</div>
158+
<div class="overlay"></div>
159+
<script src="assets/js/main.js"></script>
160+
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
161+
</body>
162+
</html>

0 commit comments

Comments
 (0)