Docs update

.github/workflows/deploy.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
   push:
     tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - "v[0-9]+.[0-9]+.[0-9]+"
 
 jobs:
   test:
@@ -18,7 +18,7 @@ jobs:
     environment: release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0
 

.github/workflows/doc.yml

@@ -3,7 +3,7 @@ on:
   workflow_dispatch:
   push:
     tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - "v[0-9]+.[0-9]+.[0-9]+"
 
 permissions:
   contents: read
@@ -22,10 +22,10 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Set up Python 3.11
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: 3.12
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

.github/workflows/test.yml

@@ -19,20 +19,20 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: 3.9
-    - uses: actions/setup-python@v5
-      with:
-        python-version: 3.11
-
-    - name: install requirements
-      run: python -m pip install nox pre-commit
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: |
+            3.10
+            3.11
+            3.12
 
-    - name: run pre-commit
-      if: ${{ matrix.os == 'ubuntu-latest' }}
-      run: pre-commit run --all --show-diff-on-failure
+      - name: install requirements
+        run: python -m pip install nox pre-commit
 
-    - name: run tests
-      run: nox
+      - name: run pre-commit
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: pre-commit run --all --show-diff-on-failure
+
+      - name: run tests
+        run: nox

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-Thanks for considering a contribution to fillname. ❤️
+Thanks for considering a contribution to fillname.
 
 ## How to get help or discuss possible contributions
 
@@ -16,7 +16,7 @@ To avoid duplicating issues, please search our [issue tracker][issues] and our
   changes.
 - Submit a pull request to the master branch with your changes.
 - Respond to feedback on your pull request.
-- If everything is fine your pull request is merged. 🥳
+- If everything is fine your pull request is merged!
 
 ## License
 

DEVELOPMENT.md

@@ -1,5 +1,11 @@
 # Development
 
+To install the project in development mode, use the following command:
+
+```bash
+pip install -e .
+```
+
 To improve code quality, we use [nox] to run linters, type checkers, unit
 tests, and more. We recommend installing nox using [pipx] to have it available
 globally.

docs/SUMMARY.md

@@ -0,0 +1,16 @@
+* Getting Started
+    * [Quick Start Guide](use/quick-start.md)
+    * [Installation](use/installation.md)
+    * [Help](use/help.md)
+* Reference
+    * [Reference](reference/index.md)
+    * [Encodings](reference/encodings/index.md)
+    * [API](reference/api/index.md)
+    * [CLI](reference/cli/index.md)
+* Examples
+    * [Examples](examples/index.md)
+* Community
+    * [Contributing](community/CONTRIBUTING.md)
+    * [Changes](community/CHANGES.md)
+    * [Development](community/DEVELOPMENT.md)
+    * [Deployment](community/DEPLOYMENT.md)

docs/_custom/css/extra.css

@@ -1,16 +1,72 @@
+/* ============================================================
+   Brand colors
+   ============================================================ */
+
 :root {
     --md-primary-fg-color: #6495ED;
 }
 
+[data-md-color-scheme="default"] .md-header,
+[data-md-color-scheme="default"] .md-tabs,
 [data-md-color-scheme="slate"] .md-header,
 [data-md-color-scheme="slate"] .md-tabs {
-    --md-primary-fg-color: #253758;
+    --md-primary-fg-color: #2E3360;
+}
+
+[data-md-color-scheme="default"] .md-nav--primary .md-nav__title,
+[data-md-color-scheme="slate"] .md-nav--primary .md-nav__title {
+    background-color: #2E3360;
+}
+
+
+/* ============================================================
+   Code highlight colors
+   ============================================================ */
+
+[data-md-color-scheme="default"] {
+    --md-code-hl-number-color: hsl(11, 80%, 40%);
+    --md-code-hl-special-color: hsl(340, 75%, 45%);
+    --md-code-hl-function-color: hsl(271, 55%, 45%);
+    --md-code-hl-constant-color: hsl(220, 70%, 45%);
+    --md-code-hl-keyword-color: var(--md-primary-fg-color);
+    --md-code-hl-string-color: hsl(160, 50%, 30%);
+    --md-code-hl-name-color: hsl(43, 90%, 32%);
+    --md-code-hl-operator-color: hsl(0, 0%, 30%);
+    --md-code-hl-punctuation-color: hsl(271, 45%, 45%);
+    --md-code-hl-comment-color: hsl(210, 15%, 50%);
+    --md-code-hl-generic-color: hsl(210, 15%, 45%);
+    --md-code-hl-variable-color: hsl(24, 70%, 38%);
+}
+
+[data-md-color-scheme="slate"] {
+    --md-code-hl-number-color: hsl(11, 85%, 68%);
+    --md-code-hl-special-color: hsl(340, 82%, 72%);
+    --md-code-hl-function-color: hsl(271, 70%, 78%);
+    --md-code-hl-constant-color: hsl(220, 80%, 75%);
+    --md-code-hl-keyword-color: #6fa3f7;
+    --md-code-hl-string-color: hsl(160, 55%, 60%);
+    --md-code-hl-name-color: hsl(43, 100%, 65%);
+    --md-code-hl-operator-color: hsl(0, 0%, 72%);
+    --md-code-hl-punctuation-color: hsl(271, 60%, 78%);
+    --md-code-hl-comment-color: hsl(210, 15%, 55%);
+    --md-code-hl-generic-color: hsl(210, 15%, 62%);
+    --md-code-hl-variable-color: hsl(24, 80%, 68%);
 }
 
+
+/* ============================================================
+   Layout
+   ============================================================ */
+
 .md-grid {
     max-width: 1350px;
 }
 
+
+/* ============================================================
+   Header
+   ============================================================ */
+
 .md-header__title {
     font-size: 1.2rem;
     height: 2.5rem;
@@ -19,7 +75,6 @@
 }
 
 .md-header__button.md-logo {
-    /* margin-left: 30; */
     padding-bottom: 0.8rem;
 }
 
@@ -28,3 +83,83 @@
     height: 1.5rem;
     width: 1.5rem;
 }
+
+
+/* ============================================================
+   Admonitions
+   ============================================================ */
+
+.md-typeset .admonition,
+.md-typeset details {
+    border-width: 0;
+    border-left-width: 3px;
+}
+
+/* info / note / abstract / tip — primary color */
+.md-typeset .info>.admonition-title,
+.md-typeset .info>summary,
+.md-typeset .note>.admonition-title,
+.md-typeset .note>summary,
+.md-typeset .abstract>.admonition-title,
+.md-typeset .abstract>summary,
+.md-typeset .tip>.admonition-title,
+.md-typeset .tip>summary {
+    border-color: var(--md-primary-fg-color);
+    background-color: color-mix(in srgb, var(--md-primary-fg-color) 10%, transparent);
+}
+
+.md-typeset .admonition.info,
+.md-typeset details.info,
+.md-typeset .admonition.note,
+.md-typeset details.note,
+.md-typeset .admonition.abstract,
+.md-typeset details.abstract,
+.md-typeset .admonition.tip,
+.md-typeset details.tip {
+    border-color: var(--md-primary-fg-color);
+}
+
+.md-typeset .info>.admonition-title::before,
+.md-typeset .info>summary::before,
+.md-typeset .note>.admonition-title::before,
+.md-typeset .note>summary::before,
+.md-typeset .abstract>.admonition-title::before,
+.md-typeset .abstract>summary::before,
+.md-typeset .tip>.admonition-title::before,
+.md-typeset .tip>summary::before {
+    background-color: var(--md-primary-fg-color);
+}
+
+/* question — yellow */
+.md-typeset .question>.admonition-title,
+.md-typeset .question>summary {
+    border-color: #A8AD00;
+    background-color: color-mix(in srgb, #A8AD00 10%, transparent);
+}
+
+.md-typeset .admonition.question,
+.md-typeset details.question {
+    border-color: #A8AD00;
+}
+
+.md-typeset .question>.admonition-title::before,
+.md-typeset .question>summary::before {
+    background-color: #A8AD00;
+}
+
+/* success — green */
+.md-typeset .success>.admonition-title,
+.md-typeset .success>summary {
+    border-color: #2E7D32;
+    background-color: color-mix(in srgb, #2E7D32 10%, transparent);
+}
+
+.md-typeset .admonition.success,
+.md-typeset details.success {
+    border-color: #2E7D32;
+}
+
+.md-typeset .success>.admonition-title::before,
+.md-typeset .success>summary::before {
+    background-color: #2E7D32;
+}