Skip to content

Commit

Permalink
Fix documentation links and README badge
Browse files Browse the repository at this point in the history
  • Loading branch information
terryzfeng committed Apr 13, 2024
1 parent 866baec commit 53aaf45
Show file tree
Hide file tree
Showing 6 changed files with 78 additions and 77 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# WebChucK

[![Node.js Build](https://github.com/ccrma/webchuck/actions/workflows/deploy.yml/badge.svg)](https://github.com/ccrma/webchuck/actions/workflows/deploy.yml)
[![](https://data.jsdelivr.com/v1/package/npm/webchuck/badge)](https://www.jsdelivr.com/package/npm/webchuck)

Expand Down
114 changes: 57 additions & 57 deletions docs/classes/Chuck.html

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/classes/HID.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">HID</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L27">src/Hid.ts:27</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L27">src/Hid.ts:27</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -64,22 +64,22 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>the<wbr/>Chuck</span><a href="#theChuck" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">the<wbr/>Chuck</span><span class="tsd-signature-symbol">:</span> <a href="Chuck.html" class="tsd-signature-type tsd-kind-class">Chuck</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L29">src/Hid.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L29">src/Hid.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="keymap" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>keymap</span><a href="#keymap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">keymap</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L30">src/Hid.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L30">src/Hid.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_mouseActive" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_mouse<wbr/>Active</span><a href="#_mouseActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">_mouse<wbr/>Active</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L31">src/Hid.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L31">src/Hid.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_kbdActive" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_kbd<wbr/>Active</span><a href="#_kbdActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">_kbd<wbr/>Active</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L32">src/Hid.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L32">src/Hid.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="boundHandleMouseMove" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>bound<wbr/>Handle<wbr/>Mouse<wbr/>Move</span><a href="#boundHandleMouseMove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">bound<wbr/>Handle<wbr/>Mouse<wbr/>Move</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
Expand All @@ -89,7 +89,7 @@ <h4>Type declaration</h4>
<li class="tsd-parameter-signature">
<ul class="tsd-signatures"></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L35">src/Hid.ts:35</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L35">src/Hid.ts:35</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="boundHandleMouseDown" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>bound<wbr/>Handle<wbr/>Mouse<wbr/>Down</span><a href="#boundHandleMouseDown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">bound<wbr/>Handle<wbr/>Mouse<wbr/>Down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
Expand All @@ -99,7 +99,7 @@ <h4>Type declaration</h4>
<li class="tsd-parameter-signature">
<ul class="tsd-signatures"></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L36">src/Hid.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L36">src/Hid.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="boundHandleMouseUp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>bound<wbr/>Handle<wbr/>Mouse<wbr/>Up</span><a href="#boundHandleMouseUp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">bound<wbr/>Handle<wbr/>Mouse<wbr/>Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
Expand All @@ -109,7 +109,7 @@ <h4>Type declaration</h4>
<li class="tsd-parameter-signature">
<ul class="tsd-signatures"></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L37">src/Hid.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L37">src/Hid.ts:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="boundHandleMouseWheel" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>bound<wbr/>Handle<wbr/>Mouse<wbr/>Wheel</span><a href="#boundHandleMouseWheel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">bound<wbr/>Handle<wbr/>Mouse<wbr/>Wheel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
Expand All @@ -119,7 +119,7 @@ <h4>Type declaration</h4>
<li class="tsd-parameter-signature">
<ul class="tsd-signatures"></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L38">src/Hid.ts:38</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L38">src/Hid.ts:38</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="boundHandleKeyDown" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>bound<wbr/>Handle<wbr/>Key<wbr/>Down</span><a href="#boundHandleKeyDown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">bound<wbr/>Handle<wbr/>Key<wbr/>Down</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
Expand All @@ -129,7 +129,7 @@ <h4>Type declaration</h4>
<li class="tsd-parameter-signature">
<ul class="tsd-signatures"></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L39">src/Hid.ts:39</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L39">src/Hid.ts:39</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="boundHandleKeyUp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>bound<wbr/>Handle<wbr/>Key<wbr/>Up</span><a href="#boundHandleKeyUp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">bound<wbr/>Handle<wbr/>Key<wbr/>Up</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
Expand All @@ -139,7 +139,7 @@ <h4>Type declaration</h4>
<li class="tsd-parameter-signature">
<ul class="tsd-signatures"></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L40">src/Hid.ts:40</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L40">src/Hid.ts:40</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="init" class="tsd-anchor"></a>
Expand Down Expand Up @@ -178,7 +178,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-0">theChuck</span
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L75">src/Hid.ts:75</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L75">src/Hid.ts:75</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="enableMouse" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>enable<wbr/>Mouse</span><a href="#enableMouse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -194,7 +194,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">// If mouse HI
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L136">src/Hid.ts:136</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L136">src/Hid.ts:136</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="disableMouse" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>disable<wbr/>Mouse</span><a href="#disableMouse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -208,7 +208,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">// If mouse HI
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L152">src/Hid.ts:152</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L152">src/Hid.ts:152</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="enableKeyboard" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>enable<wbr/>Keyboard</span><a href="#enableKeyboard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -223,7 +223,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">// If keyboard
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L169">src/Hid.ts:169</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L169">src/Hid.ts:169</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="disableKeyboard" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>disable<wbr/>Keyboard</span><a href="#disableKeyboard" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
Expand All @@ -237,7 +237,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-4">// If keyboard
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/91ca99d/src/Hid.ts#L182">src/Hid.ts:182</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/ccrma/webchuck/blob/866baec/src/Hid.ts#L182">src/Hid.ts:182</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -271,7 +271,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#enableKeyboard" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Keyboard</span></a></li>
<li><a href="#disableKeyboard" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disable<wbr/>Keyboard</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="/docs">Getting Started</a></nav>
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="./">Getting Started</a></nav>
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>webchuck</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
<li><a href="Chuck.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Chuck</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#md:documentation"><span>Documentation</span></a></li>
<li><a href="#md:for-developers"><span>For <wbr/>Developers</span></a></li></ul></li></ul></li></ul></div></details></div>
<div class="site-menu">
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="/docs">Getting Started</a></nav>
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="./">Getting Started</a></nav>
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>webchuck</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".">
<li><a href="classes/Chuck.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Chuck</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h4 class="uppercase">Member Visibility</h4><form>
<div class="tsd-theme-toggle">
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
<div class="site-menu">
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="/docs">Getting Started</a></nav>
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="./">Getting Started</a></nav>
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>webchuck</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".">
<li><a href="classes/Chuck.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Chuck</a></li>
Expand Down
2 changes: 1 addition & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"exclude": "src/DeferredPromise.ts",
"plugin": [],
"sidebarLinks": {
"Getting Started": "/docs",
"Getting Started": "./",
},
},
"include": ["src/**/*.ts"],
Expand Down

0 comments on commit 53aaf45

Please sign in to comment.