Add assets and plugins

.github/workflows/ci.yml

@@ -3,14 +3,29 @@ on:
   push:
     branches:
       - main
+permissions:
+  contents: write
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Fetch all history for all branches and tags
+
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
-      - run: pip install mkdocs-awesome-pages-plugin
-      - run: mkdocs gh-deploy --force
+
+      - id: date
+        run: echo "::set-output name=week::$(date --utc '+%V')"
+
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ steps.date.outputs.week }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - run: pip install -r requirements.txt
+      - run: mkdocs gh-deploy --force

docs/assets/css/extra.css

@@ -0,0 +1,271 @@
+@import url("https://fonts.googleapis.com/css2?family=Inter+Tight:wght@300;400;500;600;700&display=swap");
+@import url("https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@400;500&display=swap");
+
+:root {
+  --md-text-font: "Inter Tight", sans-serif;
+  --md-code-font: "Roboto Mono", monospace;
+  --md-typeset: {
+    font-size: 16px;
+    line-height: 1.5;
+  }
+}
+
+.md-grid {
+  max-width: 1500px;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-default-bg-color: hsla(var(--md-hue), 15%, 10%, 1);
+}
+
+.md-main__inner {
+  margin-top: 0;
+}
+
+.md-sidebar__inner {
+  padding-right: calc(100% - 8.5rem);
+}
+
+.md-typeset h1 {
+  font-weight: 700;
+  font-size: 1.6rem;
+  line-height: 1.5;
+  color: var(--md-text-font);
+  margin-bottom: 0.5rem;
+}
+
+.md-typeset h2 {
+  font-weight: 700;
+  font-size: 1.2rem;
+  line-height: 1.4;
+  color: var(--md-text-font);
+  margin-top: 1.5rem;
+  border-bottom: 0.01rem solid rgba(148, 148, 148, 0.218);
+  padding-bottom: 0.01rem;
+  margin-bottom: 0.9rem;
+}
+
+.md-typeset h3 {
+  font-weight: 700;
+  font-size: 0.9rem;
+  line-height: 1.3;
+  font-family: var(--md-text-font);
+}
+
+.md-typeset h4 {
+  font-weight: 600;
+  font-size: 0.8rem;
+  line-height: 1.3;
+  color: var(--md-divider-color);
+  margin: 1rem 0;
+}
+
+.md-typeset .grid {
+  grid-gap: 0.4rem;
+  display: grid;
+  grid-template-columns: repeat(auto-fit, minmax(16rem, 1fr));
+  margin: 1em 0;
+}
+
+.md-typeset .grid.cards > ol,
+.md-typeset .grid.cards > ul {
+  display: contents;
+}
+
+.md-typeset .grid.cards > ol > li,
+.md-typeset .grid.cards > ul > li,
+.md-typeset .grid > .card {
+  border: 0.01rem solid var(--md-default-fg-color--lightest);
+  border-radius: 0.2rem;
+  display: block;
+  margin: 0;
+  padding: 0.8rem;
+  transition: border 0.25s, box-shadow 0.25s;
+  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.12), 0 1px 2px rgba(0, 0, 0, 0.125);
+}
+
+.md-typeset .grid.cards > ol > li:focus-within,
+.md-typeset .grid.cards > ol > li:hover,
+.md-typeset .grid.cards > ul > li:focus-within,
+.md-typeset .grid.cards > ul > li:hover,
+.md-typeset .grid > .card:focus-within,
+.md-typeset .grid > .card:hover {
+  border-color: var(--md-shadow-z2);
+  box-shadow: var(--md-shadow-z2);
+}
+
+.md-typeset .grid.cards > ol > li > hr,
+.md-typeset .grid.cards > ul > li > hr,
+.md-typeset .grid > .card > hr {
+  margin-bottom: 1em;
+  margin-top: 1em;
+}
+
+.md-typeset .grid.cards > ol > li > :first-child,
+.md-typeset .grid.cards > ul > li > :first-child,
+.md-typeset .grid > .card > :first-child {
+  margin-top: 0;
+}
+
+.md-typeset .grid.cards > ol > li > :last-child,
+.md-typeset .grid.cards > ul > li > :last-child,
+.md-typeset .grid > .card > :last-child {
+  margin-bottom: 0;
+}
+
+.md-typeset .grid > *,
+.md-typeset .grid > .admonition,
+.md-typeset .grid > .highlight > *,
+.md-typeset .grid > .highlighttable,
+.md-typeset .grid > .md-typeset details,
+.md-typeset .grid > details,
+.md-typeset .grid > pre {
+  margin-bottom: 0;
+  margin-top: 0;
+}
+
+.md-typeset .grid > .highlight > pre:only-child,
+.md-typeset .grid > .highlight > pre > code,
+.md-typeset .grid > .highlighttable,
+.md-typeset .grid > .highlighttable > tbody,
+.md-typeset .grid > .highlighttable > tbody > tr,
+.md-typeset .grid > .highlighttable > tbody > tr > .code,
+.md-typeset .grid > .highlighttable > tbody > tr > .code > .highlight,
+.md-typeset .grid > .highlighttable > tbody > tr > .code > .highlight > pre,
+.md-typeset
+  .grid
+  > .highlighttable
+  > tbody
+  > tr
+  > .code
+  > .highlight
+  > pre
+  > code {
+  height: 100%;
+}
+
+/* Remove margins for tabbed-set elements within the grid */
+.md-typeset .grid > .tabbed-set {
+  margin-bottom: 0;
+  margin-top: 0;
+}
+
+@media screen and (min-width: 45em) {
+  [dir="ltr"] .md-typeset .inline {
+    float: left;
+  }
+
+  [dir="rtl"] .md-typeset .inline {
+    float: right;
+  }
+
+  [dir="ltr"] .md-typeset .inline {
+    margin-right: 0.8rem;
+  }
+
+  [dir="rtl"] .md-typeset .inline {
+    margin-left: 0.8rem;
+  }
+
+  .md-typeset .inline {
+    margin-bottom: 0.8rem;
+    margin-top: 0;
+    width: 11.7rem;
+  }
+
+  [dir="ltr"] .md-typeset .inline.end {
+    float: right;
+  }
+
+  [dir="rtl"] .md-typeset .inline.end {
+    float: left;
+  }
+
+  [dir="ltr"] .md-typeset .inline.end {
+    margin-left: 0.8rem;
+    margin-right: 0;
+  }
+
+  [dir="rtl"] .md-typeset .inline.end {
+    margin-left: 0;
+    margin-right: 0.8rem;
+  }
+}
+
+.md-typeset .admonition {
+  border-width: 0;
+  border-left-width: 4px;
+  font-size: initial;
+}
+
+.md-typeset details {
+  border-width: 0;
+  border-left-width: 4px;
+  font-size: initial;
+}
+
+.md-typeset details summary:before {
+  -webkit-mask-image: none;
+  mask-image: none;
+  content: none;
+  width: 0;
+}
+
+.md-typset summary {
+  padding-left: 0.02rem;
+  margin: 0;
+}
+
+[dir="ltr"] .md-typeset summary {
+  padding-left: 0.5rem;
+}
+
+.md-typeset img {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.custom-tag-details {
+  font-size: 0.8rem;
+  margin: 5px 0;
+  color: var(--md-primary-fg-color);
+  border: 1px solid lightgray;
+  border-radius: 0.2rem;
+  overflow: hidden;
+  transition: all 0.3s ease;
+}
+
+.custom-tag-details summary {
+  background-color: var(--md-primary-bg-color);
+  padding: 5px;
+  list-style: none;
+  outline: none;
+}
+
+.custom-tag-details summary::-webkit-details-marker {
+  display: none;
+}
+
+.custom-tag-details[open] summary::before {
+  transform: rotate(180deg);
+}
+
+.custom-tag-details summary::before {
+  content: "⌄";
+  font-size: 0.6rem;
+  display: inline-block;
+  margin-right: 5px;
+  transition: transform 0.3s ease;
+}
+
+.custom-tag-details p {
+  padding: 5px;
+  margin: 0;
+  color: var(--md-text-primary-on-background);
+}
+
+.md-typeset .md-tag {
+  border-radius: 0.2rem;
+  white-space: nowrap;
+}

docs/assets/js/tablesort.js

@@ -0,0 +1,6 @@
+document$.subscribe(function () {
+    var tables = document.querySelectorAll("article table:not([class])")
+    tables.forEach(function (table) {
+        new Tablesort(table)
+    })
+})