Skip to content

Commit dcab683

Browse files
farfromrefugfarfromrefug
committed
chore: doc
1 parent cd38771 commit dcab683

File tree

7 files changed

+67
-2769
lines changed

7 files changed

+67
-2769
lines changed

‎docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

‎docs/assets/highlight.css

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33
--dark-hl-0: #9CDCFE;
44
--light-hl-1: #000000;
55
--dark-hl-1: #D4D4D4;
6-
--light-hl-2: #000000;
7-
--dark-hl-2: #C8C8C8;
8-
--light-hl-3: #008000;
9-
--dark-hl-3: #6A9955;
6+
--light-hl-2: #008000;
7+
--dark-hl-2: #6A9955;
108
--light-code-background: #FFFFFF;
119
--dark-code-background: #1E1E1E;
1210
}
@@ -15,36 +13,31 @@
1513
--hl-0: var(--light-hl-0);
1614
--hl-1: var(--light-hl-1);
1715
--hl-2: var(--light-hl-2);
18-
--hl-3: var(--light-hl-3);
1916
--code-background: var(--light-code-background);
2017
} }
2118

2219
@media (prefers-color-scheme: dark) { :root {
2320
--hl-0: var(--dark-hl-0);
2421
--hl-1: var(--dark-hl-1);
2522
--hl-2: var(--dark-hl-2);
26-
--hl-3: var(--dark-hl-3);
2723
--code-background: var(--dark-code-background);
2824
} }
2925

3026
:root[data-theme='light'] {
3127
--hl-0: var(--light-hl-0);
3228
--hl-1: var(--light-hl-1);
3329
--hl-2: var(--light-hl-2);
34-
--hl-3: var(--light-hl-3);
3530
--code-background: var(--light-code-background);
3631
}
3732

3833
:root[data-theme='dark'] {
3934
--hl-0: var(--dark-hl-0);
4035
--hl-1: var(--dark-hl-1);
4136
--hl-2: var(--dark-hl-2);
42-
--hl-3: var(--dark-hl-3);
4337
--code-background: var(--dark-code-background);
4438
}
4539

4640
.hl-0 { color: var(--hl-0); }
4741
.hl-1 { color: var(--hl-1); }
4842
.hl-2 { color: var(--hl-2); }
49-
.hl-3 { color: var(--hl-3); }
5043
pre, code { background: var(--code-background); }

‎docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/core.NativeVector.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ <h4>Hierarchy</h4>
2626
<ul class="tsd-hierarchy">
2727
<li><span class="target">NativeVector</span>
2828
<ul class="tsd-hierarchy">
29+
<li><a href="geocoding_service.GeocodingResultVector.html" class="tsd-signature-type" data-tsd-kind="Class">GeocodingResultVector</a></li>
2930
<li><a href="core.MapPosVector.html" class="tsd-signature-type" data-tsd-kind="Class">MapPosVector</a></li>
3031
<li><a href="core.MapPosVectorVector.html" class="tsd-signature-type" data-tsd-kind="Class">MapPosVectorVector</a></li>
3132
<li><a href="core.IntVector.html" class="tsd-signature-type" data-tsd-kind="Class">IntVector</a></li>
3233
<li><a href="core.DoubleVector.html" class="tsd-signature-type" data-tsd-kind="Class">DoubleVector</a></li>
33-
<li><a href="geocoding_service.GeocodingResultVector.html" class="tsd-signature-type" data-tsd-kind="Class">GeocodingResultVector</a></li>
3434
<li><a href="packagemanager.PackageInfoVector.html" class="tsd-signature-type" data-tsd-kind="Class">PackageInfoVector</a></li>
3535
<li><a href="routing.RoutingInstructionVector.html" class="tsd-signature-type" data-tsd-kind="Class">RoutingInstructionVector</a></li></ul></li></ul></section><aside class="tsd-sources">
3636
<ul>

‎docs/classes/index.BaseNative.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ <h4>Hierarchy</h4>
3030
<ul class="tsd-hierarchy">
3131
<li><span class="target">BaseNative</span>
3232
<ul class="tsd-hierarchy">
33-
<li><a href="core.MapBounds.html" class="tsd-signature-type" data-tsd-kind="Class">MapBounds</a></li>
34-
<li><a href="datasources.DataSource.html" class="tsd-signature-type" data-tsd-kind="Class">DataSource</a></li>
3533
<li><a href="geocoding_service.GeocodingService.html" class="tsd-signature-type" data-tsd-kind="Class">GeocodingService</a></li>
3634
<li><a href="geocoding_service.ReverseGeocodingService.html" class="tsd-signature-type" data-tsd-kind="Class">ReverseGeocodingService</a></li>
35+
<li><a href="core.MapBounds.html" class="tsd-signature-type" data-tsd-kind="Class">MapBounds</a></li>
36+
<li><a href="datasources.DataSource.html" class="tsd-signature-type" data-tsd-kind="Class">DataSource</a></li>
3737
<li><a href="geometry_reader.GeoJSONGeometryReader.html" class="tsd-signature-type" data-tsd-kind="Class">GeoJSONGeometryReader</a></li>
3838
<li><a href="geometry_reader.WKBGeometryReader.html" class="tsd-signature-type" data-tsd-kind="Class">WKBGeometryReader</a></li>
3939
<li><a href="geometry_reader.WKTGeometryReader.html" class="tsd-signature-type" data-tsd-kind="Class">WKTGeometryReader</a></li>
@@ -48,13 +48,13 @@ <h4>Hierarchy</h4>
4848
<li><a href="routing.RoutingService.html" class="tsd-signature-type" data-tsd-kind="Class">RoutingService</a></li>
4949
<li><a href="search.VectorTileSearchService.html" class="tsd-signature-type" data-tsd-kind="Class">VectorTileSearchService</a></li>
5050
<li><a href="search.FeatureCollectionSearchService.html" class="tsd-signature-type" data-tsd-kind="Class">FeatureCollectionSearchService</a></li>
51-
<li><a href="vectortiles.VectorTileDecoder.html" class="tsd-signature-type" data-tsd-kind="Class">VectorTileDecoder</a></li>
52-
<li><a href="vectortiles.MBVectorTileDecoder.html" class="tsd-signature-type" data-tsd-kind="Class">MBVectorTileDecoder</a></li>
5351
<li><a href="utils.ZippedAssetPackage.html" class="tsd-signature-type" data-tsd-kind="Class">ZippedAssetPackage</a></li>
5452
<li><a href="utils.DirAssetPackage.html" class="tsd-signature-type" data-tsd-kind="Class">DirAssetPackage</a></li>
5553
<li><a href="vectorelements.BaseVectorElement.html" class="tsd-signature-type" data-tsd-kind="Class">BaseVectorElement</a></li>
5654
<li><a href="vectorelements.BaseVectorElementStyleBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">BaseVectorElementStyleBuilder</a></li>
57-
<li><a href="vectorelements.VectorElementVector.html" class="tsd-signature-type" data-tsd-kind="Class">VectorElementVector</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
55+
<li><a href="vectorelements.VectorElementVector.html" class="tsd-signature-type" data-tsd-kind="Class">VectorElementVector</a></li>
56+
<li><a href="vectortiles.VectorTileDecoder.html" class="tsd-signature-type" data-tsd-kind="Class">VectorTileDecoder</a></li>
57+
<li><a href="vectortiles.MBVectorTileDecoder.html" class="tsd-signature-type" data-tsd-kind="Class">MBVectorTileDecoder</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
5858
<ul>
5959
<li>Defined in packages/ui-carto/index.d.ts:12</li></ul></aside>
6060
<section class="tsd-panel-group tsd-index-group">

‎docs/globals.html

Lines changed: 0 additions & 2743 deletions
This file was deleted.

‎docs/index.html

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,18 @@ <h2>Table of Contents</h2>
6565
</ul>
6666
</li>
6767
<li><a href="#demos-and-development">Demos and Development</a><ul>
68-
<li><a href="#setup">Setup</a></li>
68+
<li><a href="#repo-setup">Repo Setup</a></li>
6969
<li><a href="#build">Build</a></li>
7070
<li><a href="#demos">Demos</a></li>
7171
</ul>
7272
</li>
73+
<li><a href="#contributing">Contributing</a><ul>
74+
<li><a href="#update-repo-">Update repo </a></li>
75+
<li><a href="#update-readme-">Update readme </a></li>
76+
<li><a href="#update-doc-">Update doc </a></li>
77+
<li><a href="#publish">Publish</a></li>
78+
</ul>
79+
</li>
7380
<li><a href="#questions">Questions</a></li>
7481
</ul>
7582
<p><a href="#installation"></a></p>
@@ -120,28 +127,68 @@ <h3>Examples</h3>
120127
<h2>Demos and Development</h2>
121128
</a>
122129

123-
<a href="#setup" id="setup" style="color: inherit; text-decoration: none;">
124-
<h3>Setup</h3>
130+
<a href="#repo-setup" id="repo-setup" style="color: inherit; text-decoration: none;">
131+
<h3>Repo Setup</h3>
125132
</a>
126-
<p>To run the demos, you must clone this repo <strong>recursively</strong>.</p>
127-
<pre><code><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-0">clone</span><span class="hl-1"> </span><span class="hl-2">https</span><span class="hl-1">:</span><span class="hl-3">//github.com/@nativescript-community/ui-carto.git --recursive</span>
128-
</code></pre>
129-
<p><strong>Install Dependencies:</strong></p>
130-
<pre><code class="language-bash"><span class="hl-1">npm i </span><span class="hl-3"># or &#39;yarn install&#39; or &#39;pnpm install&#39;</span>
133+
<p>The repo uses submodules. If you did not clone with <code> --recursive</code> then you need to call</p>
134+
<pre><code><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-0">submodule</span><span class="hl-1"> </span><span class="hl-0">update</span><span class="hl-1"> --</span><span class="hl-0">init</span>
131135
</code></pre>
136+
<p>The package manager used to install and link dependencies must be <code>pnpm</code> or <code>yarn</code>. <code>npm</code> wont work.</p>
137+
<p>To develop and test:
138+
if you use <code>yarn</code> then run <code>yarn</code>
139+
if you use <code>pnpm</code> then run <code>pnpm i</code></p>
132140
<p><strong>Interactive Menu:</strong></p>
133141
<p>To start the interactive menu, run <code>npm start</code> (or <code>yarn start</code> or <code>pnpm start</code>). This will list all of the commonly used scripts.</p>
134142

135143
<a href="#build" id="build" style="color: inherit; text-decoration: none;">
136144
<h3>Build</h3>
137145
</a>
138-
<pre><code class="language-bash"><span class="hl-1">npm run build</span><br/><br/><span class="hl-1">npm run build.angular </span><span class="hl-3"># or for Angular</span>
146+
<pre><code class="language-bash"><span class="hl-1">npm run build.all</span>
139147
</code></pre>
140148

141149
<a href="#demos" id="demos" style="color: inherit; text-decoration: none;">
142150
<h3>Demos</h3>
143151
</a>
144-
<pre><code class="language-bash"><span class="hl-1">npm run demo.[ng|react|svelte|vue].[ios|android]</span><br/><br/><span class="hl-1">npm run demo.svelte.ios </span><span class="hl-3"># Example</span>
152+
<pre><code class="language-bash"><span class="hl-1">npm run demo.[ng|react|svelte|vue].[ios|android]</span><br/><br/><span class="hl-1">npm run demo.svelte.ios </span><span class="hl-2"># Example</span>
153+
</code></pre>
154+
<p><a href="#contributing"></a></p>
155+
<p><a href="#contributing"></a></p>
156+
157+
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
158+
<h2>Contributing</h2>
159+
</a>
160+
161+
<a href="#update-repo" id="update-repo" style="color: inherit; text-decoration: none;">
162+
<h3>Update repo</h3>
163+
</a>
164+
<p>You can update the repo files quite easily</p>
165+
<p>First update the submodules</p>
166+
<pre><code class="language-bash"><span class="hl-1">npm run update</span>
167+
</code></pre>
168+
<p>Then commit the changes
169+
Then update common files</p>
170+
<pre><code class="language-bash"><span class="hl-1">npm run sync</span>
171+
</code></pre>
172+
<p>Then you can run <code>yarn|pnpm</code>, commit changed files if any</p>
173+
174+
<a href="#update-readme" id="update-readme" style="color: inherit; text-decoration: none;">
175+
<h3>Update readme</h3>
176+
</a>
177+
<pre><code class="language-bash"><span class="hl-1">npm run readme</span>
178+
</code></pre>
179+
180+
<a href="#update-doc" id="update-doc" style="color: inherit; text-decoration: none;">
181+
<h3>Update doc</h3>
182+
</a>
183+
<pre><code class="language-bash"><span class="hl-1">npm run doc</span>
184+
</code></pre>
185+
186+
<a href="#publish" id="publish" style="color: inherit; text-decoration: none;">
187+
<h3>Publish</h3>
188+
</a>
189+
<p>The publishing is completely handled by <code>lerna</code> (you can add <code>-- --bump major</code> to force a major release)
190+
Simply run </p>
191+
<pre><code class="language-shell"><span class="hl-1">npm run publish</span>
145192
</code></pre>
146193
<p><a href="#questions"></a></p>
147194
<p><a href="#questions"></a></p>

0 commit comments

Comments
 (0)