Skip to content

Commit 7272027

Browse files
CMCDragonkaiCMCDragonkai
committed
Docs are now generated on master
1 parent b9cfbf5 commit 7272027

File tree

14 files changed

+3807
-0
lines changed

14 files changed

+3807
-0
lines changed

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/assets/css/main.css‎

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

‎docs/assets/images/icons.png‎

9.39 KB
Loading

‎docs/assets/images/[email protected]‎

27.5 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: 248 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: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/lib_library.default.html‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
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>default | @matrixai/typescript-demo-lib</title>
7+
<meta name="description" content="Documentation for @matrixai/typescript-demo-lib">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
11+
</head>
12+
<body>
13+
<header>
14+
<div class="tsd-page-toolbar">
15+
<div class="container">
16+
<div class="table-wrap">
17+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18+
<div class="field">
19+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20+
<input id="tsd-search-field" type="text" />
21+
</div>
22+
<ul class="results">
23+
<li class="state loading">Preparing search index...</li>
24+
<li class="state failure">The search index is not available</li>
25+
</ul>
26+
<a href="../index.html" class="title">@matrixai/typescript-demo-lib</a>
27+
</div>
28+
<div class="table-cell" id="tsd-widgets">
29+
<div id="tsd-filter">
30+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31+
<div class="tsd-filter-group">
32+
<div class="tsd-select" id="tsd-filter-visibility">
33+
<span class="tsd-select-label">All</span>
34+
<ul class="tsd-select-list">
35+
<li data-value="public">Public</li>
36+
<li data-value="protected">Public/Protected</li>
37+
<li data-value="private" class="selected">All</li>
38+
</ul>
39+
</div>
40+
<input type="checkbox" id="tsd-filter-inherited" checked />
41+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42+
<input type="checkbox" id="tsd-filter-externals" checked />
43+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44+
</div>
45+
</div>
46+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47+
</div>
48+
</div>
49+
</div>
50+
</div>
51+
<div class="tsd-page-title">
52+
<div class="container">
53+
<ul class="tsd-breadcrumb">
54+
<li>
55+
<a href="../modules.html">@matrixai/typescript-demo-lib</a>
56+
</li>
57+
<li>
58+
<a href="../modules/lib_library.html">lib/Library</a>
59+
</li>
60+
<li>
61+
<a href="lib_library.default.html">default</a>
62+
</li>
63+
</ul>
64+
<h1>Class default</h1>
65+
</div>
66+
</div>
67+
</header>
68+
<div class="container container-main">
69+
<div class="row">
70+
<div class="col-8 col-content">
71+
<section class="tsd-panel tsd-hierarchy">
72+
<h3>Hierarchy</h3>
73+
<ul class="tsd-hierarchy">
74+
<li>
75+
<span class="target">default</span>
76+
</li>
77+
</ul>
78+
</section>
79+
<section class="tsd-panel-group tsd-index-group">
80+
<h2>Index</h2>
81+
<section class="tsd-panel tsd-index-panel">
82+
<div class="tsd-index-content">
83+
<section class="tsd-index-section ">
84+
<h3>Constructors</h3>
85+
<ul class="tsd-index-list">
86+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="lib_library.default.html#constructor" class="tsd-kind-icon">constructor</a></li>
87+
</ul>
88+
</section>
89+
<section class="tsd-index-section ">
90+
<h3>Properties</h3>
91+
<ul class="tsd-index-list">
92+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_library.default.html#someparam" class="tsd-kind-icon">some<wbr>Param</a></li>
93+
</ul>
94+
</section>
95+
</div>
96+
</section>
97+
</section>
98+
<section class="tsd-panel-group tsd-member-group ">
99+
<h2>Constructors</h2>
100+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
101+
<a name="constructor" class="tsd-anchor"></a>
102+
<h3>constructor</h3>
103+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
104+
<li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>someParam<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_library.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li>
105+
</ul>
106+
<ul class="tsd-descriptions">
107+
<li class="tsd-description">
108+
<aside class="tsd-sources">
109+
<ul>
110+
<li>Defined in <a href="https://github.com/MatrixAI/TypeScript-Demo-Lib/blob/b9cfbf5/src/lib/Library.ts#L2">lib/Library.ts:2</a></li>
111+
</ul>
112+
</aside>
113+
<h4 class="tsd-parameters-title">Parameters</h4>
114+
<ul class="tsd-parameters">
115+
<li>
116+
<h5>someParam: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;Parameter&#x27;</span></h5>
117+
</li>
118+
</ul>
119+
<h4 class="tsd-returns-title">Returns <a href="lib_library.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4>
120+
</li>
121+
</ul>
122+
</section>
123+
</section>
124+
<section class="tsd-panel-group tsd-member-group ">
125+
<h2>Properties</h2>
126+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
127+
<a name="someparam" class="tsd-anchor"></a>
128+
<h3>some<wbr>Param</h3>
129+
<div class="tsd-signature tsd-kind-icon">some<wbr>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130+
<aside class="tsd-sources">
131+
<ul>
132+
<li>Defined in <a href="https://github.com/MatrixAI/TypeScript-Demo-Lib/blob/b9cfbf5/src/lib/Library.ts#L2">lib/Library.ts:2</a></li>
133+
</ul>
134+
</aside>
135+
</section>
136+
</section>
137+
</div>
138+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
139+
<nav class="tsd-navigation primary">
140+
<ul>
141+
<li class=" ">
142+
<a href="../modules.html">Exports</a>
143+
</li>
144+
<li class=" tsd-kind-module">
145+
<a href="../modules/bin_typescript_demo_lib.html">bin/typescript-<wbr>demo-<wbr>lib</a>
146+
</li>
147+
<li class=" tsd-kind-module">
148+
<a href="../modules/index.html">index</a>
149+
</li>
150+
<li class="current tsd-kind-module">
151+
<a href="../modules/lib_library.html">lib/<wbr>Library</a>
152+
</li>
153+
</ul>
154+
</nav>
155+
<nav class="tsd-navigation secondary menu-sticky">
156+
<ul class="before-current">
157+
</ul>
158+
<ul class="current">
159+
<li class="current tsd-kind-class tsd-parent-kind-module">
160+
<a href="lib_library.default.html" class="tsd-kind-icon">default</a>
161+
<ul>
162+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
163+
<a href="lib_library.default.html#constructor" class="tsd-kind-icon">constructor</a>
164+
</li>
165+
<li class=" tsd-kind-property tsd-parent-kind-class">
166+
<a href="lib_library.default.html#someparam" class="tsd-kind-icon">some<wbr>Param</a>
167+
</li>
168+
</ul>
169+
</li>
170+
</ul>
171+
<ul class="after-current">
172+
</ul>
173+
</nav>
174+
</div>
175+
</div>
176+
</div>
177+
<footer class="with-border-bottom">
178+
<div class="container">
179+
<h2>Legend</h2>
180+
<div class="tsd-legend-group">
181+
<ul class="tsd-legend">
182+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
183+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
184+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
185+
</ul>
186+
<ul class="tsd-legend">
187+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
188+
</ul>
189+
</div>
190+
</div>
191+
</footer>
192+
<div class="container tsd-generator">
193+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
194+
</div>
195+
<div class="overlay"></div>
196+
<script src="../assets/js/main.js"></script>
197+
</body>
198+
</html>

0 commit comments

Comments
 (0)