updated readme

mkdocs.yml

@@ -1,19 +1,31 @@
 site_name: pyspotter docs
-site_description: pyspotter Simple CLI for SofarOcean API
+site_description: Simple CLI for SofarOcean API
 site_author: Samapriya Roy
 site_url: https://github.com/samapriya
 
 # Repository
 repo_name: pyspotter
-repo_url: https://github.com/samapriya/pyspotter
+repo_url: https://github.com/open-oceans/pyspotter
+edit_uri: blob/main/docs/
 
 # Copyright
-copyright: 'Copyright © 2021 - 2022 Samapriya Roy'
-
+copyright: "Copyright © 2021 - 2024 Samapriya Roy"
 
 # Configuration
 theme:
-  name: 'material'
+  name: "material"
+  custom_dir: overrides
+  features:
+    - announce.dismiss
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - content.tooltips
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
 
   # 404 page
   static_templates:
@@ -26,9 +38,18 @@ theme:
   # Default values, taken from mkdocs_theme.yml
   language: en
   palette:
-    scheme: default
-    primary: deep purple
-    accent: deep orange
+    - scheme: default
+      primary: deep purple
+      accent: deep orange
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+    - scheme: slate
+      primary: red
+      accent: red
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
   font:
     text: Google Sans
     code: Regular
@@ -43,10 +64,22 @@ extra:
       link: https://github.com/samapriya
     - icon: fontawesome/brands/medium
       link: https://medium.com/@samapriyaroy
+    - icon: fontawesome/brands/mastodon
+      link: https://mapstodon.space/@samapriya
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/samapriyaroy
     - icon: fontawesome/brands/linkedin
       link: https://www.linkedin.com/in/samapriya
+extra_css:
+  - stylesheets/extra.css
+
+plugins:
+  - search
+  - git-revision-date-localized:
+      enable_creation_date: true
+      type: timeago
+  - minify:
+      minify_html: true
 
 # Extensions
 markdown_extensions:
@@ -69,6 +102,9 @@ markdown_extensions:
   - pymdownx.emoji:
       emoji_index: !!python/name:materialx.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
+      options:
+        custom_icons:
+          - overrides/.icons
   - pymdownx.highlight
   - pymdownx.inlinehilite
   - pymdownx.keys
@@ -88,19 +124,20 @@ markdown_extensions:
       custom_checkbox: true
   - pymdownx.tilde
 
-
-
 # Page tree
 nav:
   - Introduction: index.md
   - License: license.md
   - General Installation: installation.md
   - Setup tools:
-    - Authenticate: projects/auth.md
-    - Token reset: projects/reset.md
+      - Authenticate: projects/auth.md
+      - Token reset: projects/reset.md
   - Device tools:
-    - Device list: projects/devlist.md
-    - Spot check spotter: projects/spot-check.md
+      - Device list: projects/devlist.md
+      - Spot check spotter: projects/spot-check.md
   - Device Data Export:
-    - Data export: projects/device-export.md
+      - Data export: projects/device-export.md
+  - Global Tools:
+      - Global biweekly Snapshot: projects/snapshot.md
+      - Global latest Snapshot: projects/spotter-latest.md
   - Changelog: changelog.md

overrides/main.html

@@ -0,0 +1,68 @@
+{#-
+This file was automatically generated - do not edit
+-#}
+{% extends "base.html" %}
+{% block extrahead %}
+<link rel="stylesheet" href="{{ 'assets/stylesheets/custom.f7ec4df2.min.css' | url }}">
+<style>
+    .content-container {
+        display: flex;
+        justify-content: space-between;
+        align-items: center;
+    }
+
+    .left-content {
+        flex-grow: 1;
+    }
+
+    .right-content {
+        /* Change this to your desired background color */
+        color: #fff;
+        text-align: right;
+    }
+</style>
+{% endblock %}
+{% block announce %}
+<div class="content-container">
+    <div class="left-content">
+        For updates follow <strong>@samapriya</strong> on
+        <a rel="me" href="https://www.linkedin.com/in/samapriya/">
+            <span class="twemoji linkedin">
+                {% include ".icons/fontawesome/brands/linkedin.svg" %}
+            </span>
+            <strong>Linkedin</strong>
+        </a>
+        <a rel="me" href="https://www.github.com/samapriya/">
+            <span class="twemoji github">
+                {% include ".icons/fontawesome/brands/github.svg" %}
+            </span>
+            <strong>Github</strong>
+        </a>
+        <a href="https://medium.com/@samapriyaroy">
+            <span class="twemoji medium">
+                {% include ".icons/fontawesome/brands/medium.svg" %}
+            </span>
+            <strong>Medium</strong>
+        </a>
+        <a href="https://twitter.com/samapriyaroy">
+            <span class="twemoji twitter">
+                {% include ".icons/fontawesome/brands/twitter.svg" %}
+            </span>
+            <strong>Twitter</strong>
+        </a>
+    </div>
+    <div class="right-content">
+        Support
+        <a rel="me" href="https://github.com/sponsors/samapriya">
+            <span class="twemoji sponsor">
+                {% include ".icons/octicons/sponsor-tiers-24.svg" %}
+            </span>
+            <strong>Sponsor</strong>
+        </a>
+    </div>
+</div>
+{% endblock %}
+{% block scripts %}
+{{ super() }}
+<script src="{{ 'assets/javascripts/custom.a678ee80.min.js' | url }}"></script>
+{% endblock %}