feat: docs: Edit on GitHub

microbiomedata · Jul 19, 2023 · 9b78f76 · 9b78f76
1 parent 49df9fe
commit 9b78f76
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -5,6 +5,7 @@ on:
       - main
     paths:
       - 'docs/**'
+      - 'mkdocs_overrides/**'
       - 'mkdocs.yml'
       - '.github/workflows/mkdocs.yml'
 jobs:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,6 +2,7 @@ site_name: nmdc-runtime docs
 site_description: Documentation for the National Microbiome Data Collaborative (NMDC) Runtime System and API
 site_url: https://microbiomedata.github.io/nmdc-runtime/
 repo_url: https://github.com/microbiomedata/nmdc-runtime/
+edit_uri_template: 'blob/main/docs/{path}'
 nav:
   - index.md
   - Tutorials:
@@ -29,6 +30,7 @@ nav:
 
 theme:
   name: material
+  custom_dir: mkdocs_overrides
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default

diff --git a/mkdocs_overrides/partials/source.html b/mkdocs_overrides/partials/source.html
@@ -0,0 +1,9 @@
+<a href="{{ page.edit_url }}" title="{{ lang.t('source') }}" class="md-source" data-md-component="source">
+  <div class="md-source__icon md-icon">
+    {% set icon = config.theme.icon.repo or "fontawesome/brands/git-alt" %}
+    {% include ".icons/" ~ icon ~ ".svg" %}
+  </div>
+  <div class="md-source__repository">
+    Edit on {{ config.repo_name }}
+  </div>
+</a>