Skip to content

Commit 0121442

Browse files
meswapnilwaghmeswapnilwagh
committed
document updated
1 parent 8ed00f2 commit 0121442

File tree

7 files changed

+26
-33
lines changed

7 files changed

+26
-33
lines changed

‎docs/assets/highlight.css

-14
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@
99
--dark-hl-3: #CE9178;
1010
--light-hl-4: #098658;
1111
--dark-hl-4: #B5CEA8;
12-
--light-hl-5: #000000;
13-
--dark-hl-5: #C8C8C8;
14-
--light-hl-6: #008000;
15-
--dark-hl-6: #6A9955;
1612
--light-code-background: #F5F5F5;
1713
--dark-code-background: #1E1E1E;
1814
}
@@ -23,8 +19,6 @@
2319
--hl-2: var(--light-hl-2);
2420
--hl-3: var(--light-hl-3);
2521
--hl-4: var(--light-hl-4);
26-
--hl-5: var(--light-hl-5);
27-
--hl-6: var(--light-hl-6);
2822
--code-background: var(--light-code-background);
2923
} }
3024

@@ -34,8 +28,6 @@
3428
--hl-2: var(--dark-hl-2);
3529
--hl-3: var(--dark-hl-3);
3630
--hl-4: var(--dark-hl-4);
37-
--hl-5: var(--dark-hl-5);
38-
--hl-6: var(--dark-hl-6);
3931
--code-background: var(--dark-code-background);
4032
} }
4133

@@ -45,8 +37,6 @@ body.light {
4537
--hl-2: var(--light-hl-2);
4638
--hl-3: var(--light-hl-3);
4739
--hl-4: var(--light-hl-4);
48-
--hl-5: var(--light-hl-5);
49-
--hl-6: var(--light-hl-6);
5040
--code-background: var(--light-code-background);
5141
}
5242

@@ -56,8 +46,6 @@ body.dark {
5646
--hl-2: var(--dark-hl-2);
5747
--hl-3: var(--dark-hl-3);
5848
--hl-4: var(--dark-hl-4);
59-
--hl-5: var(--dark-hl-5);
60-
--hl-6: var(--dark-hl-6);
6149
--code-background: var(--dark-code-background);
6250
}
6351

@@ -66,6 +54,4 @@ body.dark {
6654
.hl-2 { color: var(--hl-2); }
6755
.hl-3 { color: var(--hl-3); }
6856
.hl-4 { color: var(--hl-4); }
69-
.hl-5 { color: var(--hl-5); }
70-
.hl-6 { color: var(--hl-6); }
7157
pre, code { background: var(--code-background); }

‎docs/index.html

+12-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
<a href="#🌏-worldpedia" id="🌏-worldpedia" style="color: inherit; text-decoration: none;">
33
<h1>🌏 Worldpedia</h1>
44
</a>
5-
<p><img src="https://user-images.githubusercontent.com/4816238/153756023-94f0dd8f-d286-403b-968a-078940d5cdf3.png" alt="image"></p>
65
<blockquote>
76
<p>“Worldpedia” is javascript library that will give you access to data of Continents, Subregions, Country, States &amp; Cities</p>
87
</blockquote>
9-
<p>Get a list of countries of specific continents, get a list of states of countries, get a list of cities of states, countries belonging to specific subregion.</p>
8+
<p><img src="https://user-images.githubusercontent.com/4816238/153756023-94f0dd8f-d286-403b-968a-078940d5cdf3.png" alt="image"></p>
109
<p align="center">
1110
<img src="https://img.shields.io/npm/dw/worldpedia?logo=npm&style=for-the-badge"/>
1211
<img src="https://img.shields.io/npm/v/worldpedia?logo=npm&style=for-the-badge"/>
@@ -15,6 +14,16 @@ <h1>🌏 Worldpedia</h1>
1514
</p>
1615

1716

17+
<a href="#⛳-features" id="⛳-features" style="color: inherit; text-decoration: none;">
18+
<h1>⛳ Features</h1>
19+
</a>
20+
<ul>
21+
<li>Get a list of countries of specific continents</li>
22+
<li>Get a list of states of countries </li>
23+
<li>Get a list of cities of states</li>
24+
<li>Get countries belonging to specific subregion</li>
25+
</ul>
26+
1827
<a href="#⚙️-install" id="⚙️-install" style="color: inherit; text-decoration: none;">
1928
<h1>⚙️ Install</h1>
2029
</a>
@@ -189,9 +198,7 @@ <h3>getAllCitiesByCountry(countryCode: string)</h3>
189198
<h1>✍️ How to Contribute</h1>
190199
</a>
191200
<ul>
192-
<li>Clone repo and create a new branch: <pre><code><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-0">checkout</span><span class="hl-1"> </span><span class="hl-5">https</span><span class="hl-1">:</span><span class="hl-6">//github.com/meswapnilwagh/worldpedia -b branch-name</span>
193-
</code></pre>
194-
</li>
201+
<li>Clone repo and create a new branch: $ git checkout <a href="https://github.com/meswapnilwagh/worldpedia">https://github.com/meswapnilwagh/worldpedia</a> -b branch-name.</li>
195202
<li>Make changes and test</li>
196203
<li>Submit Pull Request with comprehensive description of changes</li>
197204
</ul>

‎docs/modules/City.html

+3-3
Large diffs are not rendered by default.

‎docs/modules/Continent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Continent | worldpedia</title><meta name="description" content="Documentation for worldpedia"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">worldpedia</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">worldpedia</a></li><li><a href="Continent.html">Continent</a></li></ul><h1>Namespace Continent</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Continent.html#getAllContinents" class="tsd-kind-icon">get<wbr/>All<wbr/>Continents</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Continent.html#getContinentByCode" class="tsd-kind-icon">get<wbr/>Continent<wbr/>By<wbr/>Code</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getAllContinents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>All<wbr/>Continents<a href="#getAllContinents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>All<wbr/>Continents<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IContinent</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/meswapnilwagh/worldpedia/blob/c52e26f/src/modules/continents.ts#L9">modules/continents.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Continent | worldpedia</title><meta name="description" content="Documentation for worldpedia"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">worldpedia</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">worldpedia</a></li><li><a href="Continent.html">Continent</a></li></ul><h1>Namespace Continent</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Continent.html#getAllContinents" class="tsd-kind-icon">get<wbr/>All<wbr/>Continents</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Continent.html#getContinentByCode" class="tsd-kind-icon">get<wbr/>Continent<wbr/>By<wbr/>Code</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getAllContinents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>All<wbr/>Continents<a href="#getAllContinents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>All<wbr/>Continents<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IContinent</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/meswapnilwagh/worldpedia/blob/8ed00f2/src/modules/continents.ts#L9">modules/continents.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
<p>Get all continents</p>
33
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IContinent</span><span class="tsd-signature-symbol">[]</span></h4><div><p>{IContinent[]}</p>
4-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getContinentByCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Continent<wbr/>By<wbr/>Code<a href="#getContinentByCode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Continent<wbr/>By<wbr/>Code<span class="tsd-signature-symbol">(</span>code<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><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IContinent</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/meswapnilwagh/worldpedia/blob/c52e26f/src/modules/continents.ts#L19">modules/continents.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace"><a id="getContinentByCode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> get<wbr/>Continent<wbr/>By<wbr/>Code<a href="#getContinentByCode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace"><li class="tsd-signature tsd-kind-icon">get<wbr/>Continent<wbr/>By<wbr/>Code<span class="tsd-signature-symbol">(</span>code<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><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IContinent</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/meswapnilwagh/worldpedia/blob/8ed00f2/src/modules/continents.ts#L19">modules/continents.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
55
<p>Get continent by code</p>
66
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>code: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">IContinent</span></h4><div><p>{(IContinent | undefined)}</p>
77
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="City.html">City</a></li><li class="current tsd-kind-namespace"><a href="Continent.html">Continent</a></li><li class=" tsd-kind-namespace"><a href="Country.html">Country</a></li><li class=" tsd-kind-namespace"><a href="State.html">State</a></li><li class=" tsd-kind-namespace"><a href="Subregion.html">Subregion</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Continent.html#getAllContinents" class="tsd-kind-icon">get<wbr/>All<wbr/>Continents</a></li><li class="tsd-kind-function tsd-parent-kind-namespace"><a href="Continent.html#getContinentByCode" class="tsd-kind-icon">get<wbr/>Continent<wbr/>By<wbr/>Code</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

0 commit comments

Comments
 (0)