Skip to content

Commit

Permalink
docs: update typedoc site
Browse files Browse the repository at this point in the history
  • Loading branch information
@GitSquared
GitSquared committed Jan 27, 2022
1 parent 355aacd commit afceb79
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 106 deletions.
1 change: 0 additions & 1 deletion .husky/pre-commit
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@
. "$(dirname "$0")/_/husky.sh"

npm run build
npm run make-docs
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ You can add this to your `package.json` to preload the databases after running `

## API

You can find a more detailed documentation [on the Typedoc-generated website](https://gitsquared.github.io/node-geolite2-redist/).
You can find a more detailed documentation [on the Typedoc-generated website](https://gitsquared.github.io/node-geolite2-redist/modules.html).

## Legal Warning

Expand Down
22 changes: 18 additions & 4 deletions docs/assets/highlight.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@
--dark-hl-3: #DCDCAA;
--light-hl-4: #A31515;
--dark-hl-4: #CE9178;
--light-hl-5: #AF00DB;
--dark-hl-5: #C586C0;
--light-hl-5: #008000;
--dark-hl-5: #6A9955;
--light-hl-6: #001080;
--dark-hl-6: #9CDCFE;
--light-hl-7: #008000;
--dark-hl-7: #6A9955;
--light-hl-7: #AF00DB;
--dark-hl-7: #C586C0;
--light-hl-8: #267F99;
--dark-hl-8: #4EC9B0;
--light-hl-9: #0451A5;
--dark-hl-9: #9CDCFE;
--light-hl-10: #EE0000;
--dark-hl-10: #D7BA7D;
--light-code-background: #F5F5F5;
--dark-code-background: #1E1E1E;
}
Expand All @@ -31,6 +35,8 @@
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--hl-10: var(--light-hl-10);
--code-background: var(--light-code-background);
} }

Expand All @@ -44,6 +50,8 @@
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--hl-10: var(--dark-hl-10);
--code-background: var(--dark-code-background);
} }

Expand All @@ -57,6 +65,8 @@ body.light {
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--hl-9: var(--light-hl-9);
--hl-10: var(--light-hl-10);
--code-background: var(--light-code-background);
}

Expand All @@ -70,6 +80,8 @@ body.dark {
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--hl-9: var(--dark-hl-9);
--hl-10: var(--dark-hl-10);
--code-background: var(--dark-code-background);
}

Expand All @@ -82,4 +94,6 @@ body.dark {
.hl-6 { color: var(--hl-6); }
.hl-7 { color: var(--hl-7); }
.hl-8 { color: var(--hl-8); }
.hl-9 { color: var(--hl-9); }
.hl-10 { color: var(--hl-10); }
pre, code { background: var(--code-background); }
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/enums/GeoIpDbName.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GeoIpDbName | geolite2-redist - v3.0.0</title><meta name="description" content="Documentation for geolite2-redist - v3.0.0"/><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">geolite2-redist - v3.0.0</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></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">geolite2-redist - v3.0.0</a></li><li><a href="GeoIpDbName.html">GeoIpDbName</a></li></ul><h1>Enumeration GeoIpDbName</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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#ASN" class="tsd-kind-icon">ASN</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#City" class="tsd-kind-icon">City</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#Country" class="tsd-kind-icon">Country</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ASN" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ASN<a href="#ASN" 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><div class="tsd-signature tsd-kind-icon">ASN<span class="tsd-signature-symbol"> = &quot;GeoLite2-ASN&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GitSquared/node-geolite2-redist/blob/2fc6439/src/index.ts#L6">index.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="City" class="tsd-anchor"></a><h3 class="tsd-anchor-link">City<a href="#City" 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><div class="tsd-signature tsd-kind-icon">City<span class="tsd-signature-symbol"> = &quot;GeoLite2-City&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GitSquared/node-geolite2-redist/blob/2fc6439/src/index.ts#L8">index.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Country" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Country<a href="#Country" 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><div class="tsd-signature tsd-kind-icon">Country<span class="tsd-signature-symbol"> = &quot;GeoLite2-Country&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GitSquared/node-geolite2-redist/blob/2fc6439/src/index.ts#L7">index.ts:7</a></li></ul></aside></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="GeoIpDbName.html" class="tsd-kind-icon">Geo<wbr/>Ip<wbr/>Db<wbr/>Name</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#ASN" class="tsd-kind-icon">ASN</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#City" class="tsd-kind-icon">City</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#Country" class="tsd-kind-icon">Country</a></li></ul></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>
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GeoIpDbName | geolite2-redist - v3.0.0</title><meta name="description" content="Documentation for geolite2-redist - v3.0.0"/><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">geolite2-redist - v3.0.0</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></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">geolite2-redist - v3.0.0</a></li><li><a href="GeoIpDbName.html">GeoIpDbName</a></li></ul><h1>Enumeration GeoIpDbName</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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#ASN" class="tsd-kind-icon">ASN</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#City" class="tsd-kind-icon">City</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#Country" class="tsd-kind-icon">Country</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ASN" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ASN<a href="#ASN" 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><div class="tsd-signature tsd-kind-icon">ASN<span class="tsd-signature-symbol"> = &quot;GeoLite2-ASN&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GitSquared/node-geolite2-redist/blob/fab850c/src/primitives.ts#L2">primitives.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="City" class="tsd-anchor"></a><h3 class="tsd-anchor-link">City<a href="#City" 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><div class="tsd-signature tsd-kind-icon">City<span class="tsd-signature-symbol"> = &quot;GeoLite2-City&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GitSquared/node-geolite2-redist/blob/fab850c/src/primitives.ts#L4">primitives.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Country" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Country<a href="#Country" 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><div class="tsd-signature tsd-kind-icon">Country<span class="tsd-signature-symbol"> = &quot;GeoLite2-Country&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/GitSquared/node-geolite2-redist/blob/fab850c/src/primitives.ts#L3">primitives.ts:3</a></li></ul></aside></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></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="GeoIpDbName.html" class="tsd-kind-icon">Geo<wbr/>Ip<wbr/>Db<wbr/>Name</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#ASN" class="tsd-kind-icon">ASN</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#City" class="tsd-kind-icon">City</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="GeoIpDbName.html#Country" class="tsd-kind-icon">Country</a></li></ul></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>
Loading

0 comments on commit afceb79

Please sign in to comment.