chore: add typedoc and use to generate updated documenation when publishing

docs/assets/highlight.css

@@ -0,0 +1,85 @@
+:root {
+    --light-hl-0: #0000FF;
+    --dark-hl-0: #569CD6;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #0070C1;
+    --dark-hl-2: #4FC1FF;
+    --light-hl-3: #795E26;
+    --dark-hl-3: #DCDCAA;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
+    --light-hl-5: #001080;
+    --dark-hl-5: #9CDCFE;
+    --light-hl-6: #AF00DB;
+    --dark-hl-6: #C586C0;
+    --light-hl-7: #098658;
+    --dark-hl-7: #B5CEA8;
+    --light-hl-8: #008000;
+    --dark-hl-8: #6A9955;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+pre, code { background: var(--code-background); }

docs/assets/material-style.css

@@ -0,0 +1,247 @@
+@import url("https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300;400;500;600;700&family=Space+Mono:ital,wght@0,400;0,700;1,400;1,700&display=swap");
+
+:root,
+:root[data-theme="light"],
+:root[data-theme="dark"] {
+  --font-sans: "Space Grotesk", sans-serif;
+  --font-mono: "Space Mono", monospace;
+
+  --color-background: var(--md-sys-color-surface-container);
+  --color-background-secondary: var(--md-sys-color-surface-container-high);
+  --color-background-warning: var(--md-sys-color-error-container);
+  --color-warning-text: var(--md-sys-color-on-error-container);
+  --color-icon-background: var(--md-sys-color-on-primary);
+  --color-accent: var(--md-sys-color-secondary-container);
+  --color-active-menu-item: var(--md-sys-color-surface-container-highest);
+  --color-text: var(--md-sys-color-on-surface);
+  --color-text-aside: var(--md-sys-color-on-surface-variant);
+  --color-link: var(--md-sys-color-primary);
+
+  --color-ts-project: var(--md-sys-color-secondary);
+  --color-ts-module: var(--color-ts-project);
+  --color-ts-namespace: var(--color-ts-project);
+
+  --color-ts-enum: var(--md-sys-color-tertiary);
+  --color-ts-enum-member: var(--color-ts-enum);
+
+  --color-ts-variable: var(--md-sys-color-primary);
+  --color-ts-function: var(--md-sys-color-secondary);
+  --color-ts-class: var(--md-sys-color-tertiary);
+  --color-ts-interface: var(--md-sys-color-tertiary);
+
+  --color-ts-constructor: var(--md-sys-color-inverse-primary);
+
+  --color-ts-property: var(--md-sys-color-on-background);
+  --color-ts-method: var(--color-ts-function);
+
+  --color-ts-call-signature: var(--color-ts-method);
+  --color-ts-index-signature: var(--color-ts-property); /* ? */
+  --color-ts-constructor-signature: var(--color-ts-function);
+  --color-ts-parameter: var(--md-sys-color-primary);
+
+  --color-ts-type-parameter: var(--md-sys-color-tertiary);
+  --color-ts-accessor: var(--color-ts-property);
+  --color-ts-get-signature: var(--color-ts-accessor);
+  --color-ts-set-signature: var(--color-ts-accessor);
+  --color-ts-type-alias: var(--md-sys-color-tertiary);
+
+  /* --external-icon: var(--md-sys-external-icon);
+  --color-scheme: var(--md-sys-color-scheme); */
+
+  --top-app-bar-height: 4.5rem;
+  --footer-height: 3.5rem;
+}
+
+body {
+  font-family: var(--font-sans);
+}
+code,
+pre {
+  font-family: var(--font-mono);
+}
+
+img {
+  max-width: 100%;
+}
+
+*::-webkit-scrollbar {
+  width: 8px;
+  height: 8px;
+}
+*::-webkit-scrollbar-track {
+  background: none;
+}
+*::-webkit-scrollbar-thumb {
+  border: none;
+}
+
+.container-main {
+  min-height: calc(100vh - var(--top-app-bar-height) - var(--footer-height));
+}
+.col-content {
+  overflow: hidden;
+  box-sizing: border-box;
+  padding: 1.75rem;
+  border-radius: 28px;
+  background-color: var(--md-sys-color-surface);
+}
+.page-menu {
+  height: fit-content;
+  padding: 0.75rem 1.75rem;
+  border-radius: 28px;
+  background-color: var(--md-sys-color-surface);
+}
+.site-menu > *,
+.page-menu > * {
+  position: relative;
+}
+.title {
+  display: block;
+  max-width: calc(100% - 5rem);
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  font-size: 22px;
+}
+
+.tsd-page-toolbar {
+  padding: 8px 0;
+  height: calc(var(--top-app-bar-height) - 16px);
+  background-color: var(--color-background);
+  border-bottom: none;
+}
+.tsd-page-toolbar .tsd-toolbar-contents {
+  height: 56px;
+}
+.tsd-page-toolbar .table-cell {
+  height: 56px;
+  margin-left: 1.5rem;
+}
+.tsd-page-toolbar .tsd-toolbar-icon {
+  padding: 20px 0;
+}
+#tsd-search {
+  line-height: 56px;
+  border-radius: 22px;
+}
+#tsd-search .results {
+  z-index: -1;
+  top: calc(56px - 22px);
+  padding-top: 22px;
+  box-shadow: 0px 4px 2px rgba(0, 0, 0, 0.125);
+  background-color: var(--color-background-secondary);
+  border-bottom-left-radius: 22px;
+  border-bottom-right-radius: 22px;
+  overflow: hidden;
+}
+#tsd-search .results li {
+  background: none;
+}
+#tsd-search .results a {
+  padding: 1rem 0.25rem;
+}
+.col-sidebar {
+  padding-top: 0;
+  margin-right: 1rem;
+}
+
+.tsd-signature {
+  padding: 1rem 1.5rem;
+  border-radius: 24px;
+  background-color: var(--md-sys-color-surface-container);
+}
+
+.tsd-page-navigation ul {
+  padding-left: 0.44rem;
+}
+.tsd-navigation a,
+.tsd-navigation summary > span,
+.tsd-page-navigation a {
+  padding: 0.88rem;
+  border-radius: 24px;
+}
+.tsd-navigation a:hover,
+.tsd-page-navigation a:hover {
+  text-decoration: none;
+  background-color: var(--md-sys-color-surface-container-high);
+}
+.page-menu .tsd-accordion-summary svg {
+  position: absolute;
+  right: 0;
+}
+.site-menu .tsd-navigation .tsd-accordion-summary {
+  display: flex;
+  flex-direction: row-reverse;
+  width: 100%;
+}
+
+.tsd-small-nested-navigation {
+  margin-left: 1rem;
+}
+.tsd-nested-navigation {
+  margin-left: 2.5rem;
+}
+.tsd-nested-navigation > li > a,
+.tsd-nested-navigation > li > span {
+  width: 100%;
+}
+.tsd-navigation > a,
+.tsd-navigation .tsd-accordion-summary {
+  width: 100%;
+}
+.tsd-index-accordion .tsd-accordion-summary > svg {
+  position: absolute;
+  right: 1.5rem;
+  margin-top: 1rem;
+}
+.tsd-accordion-summary .tsd-kind-icon ~ span {
+  margin-right: 2.5rem;
+}
+.tsd-accordion-summary .tsd-nested-navigation > li > a,
+.tsd-nested-navigation > li > span {
+  width: calc(100% - 0.44rem);
+}
+.tsd-kind-icon ~ span {
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+.tsd-generator {
+  padding: 0;
+  border-top: none;
+  height: var(--footer-height);
+  line-height: var(--footer-height);
+}
+.tsd-generator > p {
+  padding: 0 2rem;
+}
+
+@media (max-width: 769px) {
+  .container {
+    padding: 1rem;
+  }
+  .col-sidebar {
+    margin-right: 0;
+  }
+}
+@media (min-width: 770px) {
+  .container-main {
+    margin: 0 auto;
+  }
+  .site-menu {
+    margin-right: 0.5rem;
+  }
+}
+@media (min-width: 1200px) {
+  .page-menu,
+  .site-menu {
+    max-height: calc(100vh - var(--footer-height) - var(--top-app-bar-height));
+    top: var(--top-app-bar-height);
+  }
+  .page-menu {
+    margin-left: 1rem;
+  }
+  .col-sidebar {
+    margin-right: 0;
+  }
+}

docs/assets/navigation.js

@@ -0,0 +1 @@
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACo2XQY/TMBCF/0vOFSs4od5Kl10igQrtCg6Ig5XMthaObZwxS4X47ygNdGN7PPY1773P8djjxF9/Nwi/sFk3twLFnXGDwGbVWIGnZt2A9sN486y8OOGgmlXzXeq+Wb/+s3pOg4KjQHg4W0jyCy1PuJOg+gMK9GMMWEiFPDX8VeCyCg5onDjCQSJBCGSWg+B2FpxA44h5BDLDMW7wSuw8Wo/knGJDnvUO0c6125o+AYVqnvLBK5RWyU7iOWYstTxhD51x/WehPLlJIpnjWONw2pM0ZqnmKQ9ygIMVutWdgwF0sukTQ5m1h847B7ojJ0i78tSNlXsYrdHjAtUpMY4w3izEkPDyVciwVNayGUTRncKSXKNXrY7wXo64WFgOGFk5/tYoBR1Ko/MFSj0s0YFA6L9IPLU9A6VsHPdWILDzjwwsCzo5CMXjEg9PnM9lijMrNeniGmeMHPut7q2RGu9Eh8adU2Zk4FiX4z8lXB7zOUVMZnpaSrX60dDJSSmli/UkTCxz/lTkyrBQOco94EdxhH5j7ZhvEMpVQ70MX8ENfTXkuUgV6MhYx56+NVXswFhgz2+yhx8eRuIMjh1VtPHNeWNtW0GNnHX0CmwNz8u+uPsJU4lZ5FWyWo1wBFd8RdpXQa6hVhKnwTMtf5VK+RZhyK5sZKhj5RoldpRomRJdJS6/06N1Uh+3SpL/OKHOkf71dm5SgVzgSH3MVjqQOc4nD+483zFSykIsMkpdTZg45uxMMfPzcjKz2pWdsIdHuPxuZ9oh1HnSdIxThOl5OTndSnLpSWMJ5omImicucxA/YfpZyK5jZCixCh+mxFLLyzVQ6mGJnZna9t4ZT1x6lmotpXjQM2Z2DJxSZTplK3MrmJW8/zdWet8u1RoK+16EKWV++wv61xb7rRIAAA=="