docs: update documentation [skip ci]

ChainSafe · Feb 8, 2024 · 0a29189 · 0a29189
1 parent 4167eeb
commit 0a29189
Show file tree

Hide file tree

Showing 19 changed files with 149 additions and 123 deletions.
diff --git a/assets/highlight.css b/assets/highlight.css
@@ -1,32 +1,32 @@
 :root {
-    --light-hl-0: #000000;
-    --dark-hl-0: #D4D4D4;
-    --light-hl-1: #800000;
-    --dark-hl-1: #808080;
-    --light-hl-2: #800000;
-    --dark-hl-2: #569CD6;
-    --light-hl-3: #000000FF;
-    --dark-hl-3: #D4D4D4;
-    --light-hl-4: #E50000;
-    --dark-hl-4: #9CDCFE;
-    --light-hl-5: #0000FF;
-    --dark-hl-5: #CE9178;
-    --light-hl-6: #AF00DB;
-    --dark-hl-6: #C586C0;
-    --light-hl-7: #001080;
-    --dark-hl-7: #9CDCFE;
-    --light-hl-8: #A31515;
-    --dark-hl-8: #CE9178;
-    --light-hl-9: #0000FF;
-    --dark-hl-9: #569CD6;
-    --light-hl-10: #0070C1;
-    --dark-hl-10: #4FC1FF;
-    --light-hl-11: #795E26;
-    --dark-hl-11: #DCDCAA;
-    --light-hl-12: #008000;
-    --dark-hl-12: #6A9955;
-    --light-hl-13: #098658;
-    --dark-hl-13: #B5CEA8;
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #A31515;
+    --dark-hl-3: #CE9178;
+    --light-hl-4: #0000FF;
+    --dark-hl-4: #569CD6;
+    --light-hl-5: #0070C1;
+    --dark-hl-5: #4FC1FF;
+    --light-hl-6: #795E26;
+    --dark-hl-6: #DCDCAA;
+    --light-hl-7: #008000;
+    --dark-hl-7: #6A9955;
+    --light-hl-8: #098658;
+    --dark-hl-8: #B5CEA8;
+    --light-hl-9: #800000;
+    --dark-hl-9: #808080;
+    --light-hl-10: #800000;
+    --dark-hl-10: #569CD6;
+    --light-hl-11: #000000FF;
+    --dark-hl-11: #D4D4D4;
+    --light-hl-12: #E50000;
+    --dark-hl-12: #9CDCFE;
+    --light-hl-13: #0000FF;
+    --dark-hl-13: #CE9178;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }

diff --git a/assets/main.js b/assets/main.js
diff --git a/assets/style.css b/assets/style.css
@@ -29,7 +29,7 @@
     --light-color-ts-constructor-signature: var(--light-color-ts-constructor);
     --light-color-ts-parameter: var(--light-color-ts-variable);
     /* type literal not included as links will never be generated to it */
-    --light-color-ts-type-parameter: var(--light-color-ts-type-alias);
+    --light-color-ts-type-parameter: #a55c0e;
     --light-color-ts-accessor: var(--light-color-ts-property);
     --light-color-ts-get-signature: var(--light-color-ts-accessor);
     --light-color-ts-set-signature: var(--light-color-ts-accessor);
@@ -69,7 +69,7 @@
     --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor);
     --dark-color-ts-parameter: var(--dark-color-ts-variable);
     /* type literal not included as links will never be generated to it */
-    --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias);
+    --dark-color-ts-type-parameter: #e07d13;
     --dark-color-ts-accessor: var(--dark-color-ts-property);
     --dark-color-ts-get-signature: var(--dark-color-ts-accessor);
     --dark-color-ts-set-signature: var(--dark-color-ts-accessor);
@@ -266,12 +266,12 @@ h6 {
     line-height: 1.2;
 }
 
-h1 > a,
-h2 > a,
-h3 > a,
-h4 > a,
-h5 > a,
-h6 > a {
+h1 > a:not(.link),
+h2 > a:not(.link),
+h3 > a:not(.link),
+h4 > a:not(.link),
+h5 > a:not(.link),
+h6 > a:not(.link) {
     text-decoration: none;
     color: var(--color-text);
 }
@@ -649,6 +649,28 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     font-weight: bold;
 }
 
+.tsd-full-hierarchy:not(:last-child) {
+    margin-bottom: 1em;
+    padding-bottom: 1em;
+    border-bottom: 1px solid var(--color-accent);
+}
+.tsd-full-hierarchy,
+.tsd-full-hierarchy ul {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+}
+.tsd-full-hierarchy ul {
+    padding-left: 1.5rem;
+}
+.tsd-full-hierarchy a {
+    padding: 0.25rem 0 !important;
+    font-size: 1rem;
+    display: inline-flex;
+    align-items: center;
+    color: var(--color-text);
+}
+
 .tsd-panel-group.tsd-index-group {
     margin-bottom: 0;
 }
@@ -714,12 +736,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
 }
 .tsd-navigation > a,
 .tsd-navigation .tsd-accordion-summary {
-    width: calc(100% - 0.5rem);
+    width: calc(100% - 0.25rem);
+    display: flex;
+    align-items: center;
 }
 .tsd-navigation a,
 .tsd-navigation summary > span,
 .tsd-page-navigation a {
-    display: inline-flex;
+    display: flex;
+    width: calc(100% - 0.25rem);
     align-items: center;
     padding: 0.25rem;
     color: var(--color-text);
@@ -759,11 +784,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
     margin-left: -1.5rem;
 }
 
-.tsd-nested-navigation > li > a,
-.tsd-nested-navigation > li > span {
-    width: calc(100% - 1.75rem - 0.5rem);
-}
-
 .tsd-page-navigation ul {
     padding-left: 1.75rem;
 }

diff --git a/classes/stream.YamuxStream.html b/classes/stream.YamuxStream.html
diff --git a/enums/index.FrameType.html b/enums/index.FrameType.html
diff --git a/enums/index.GoAwayCode.html b/enums/index.GoAwayCode.html
diff --git a/enums/stream.StreamState.html b/enums/stream.StreamState.html
diff --git a/functions/config.verifyConfig.html b/functions/config.verifyConfig.html
diff --git a/functions/index.yamux.html b/functions/index.yamux.html
diff --git a/index.html b/index.html
diff --git a/interfaces/config.Config.html b/interfaces/config.Config.html
diff --git a/interfaces/index.FrameHeader.html b/interfaces/index.FrameHeader.html
diff --git a/interfaces/index.YamuxMuxerComponents.html b/interfaces/index.YamuxMuxerComponents.html
diff --git a/interfaces/index.YamuxMuxerInit.html b/interfaces/index.YamuxMuxerInit.html
diff --git a/interfaces/stream.YamuxStreamInit.html b/interfaces/stream.YamuxStreamInit.html
diff --git a/modules/config.html b/modules/config.html
diff --git a/modules/index.html b/modules/index.html
diff --git a/modules/stream.html b/modules/stream.html
diff --git a/variables/config.defaultConfig.html b/variables/config.defaultConfig.html