mkdocs.yml

+site_name: HCC-DOCS
+dev_addr: 0.0.0.0:8080
+site_url: https://hcc.unl.edu/docs/
+copyright: Holland Computing Center | 118 Schorr Center, Lincoln NE 68588
+repo_url: https://git.unl.edu/hcc/hcc-docs
+repo_name: hcc/hcc-docs
+edit_uri: edit/master/docs/
+
+theme:
+  name: material
+  custom_dir: overrides
+  logo: images/site/UNMasterwhite.gif
+  favicon: images/site/favicon.png
+  icon:
+    repo: fontawesome/brands/gitlab
+  features:
+    - content.code.copy
+    - content.action.edit
+    - content.code.select
+    - navigation.indexes
+    - navigation.tracking
+    - navigation.instant: true
+    - navigation.indexes
+    - search.suggest
+    - announce.dismiss
+    #- toc.integrate # Moves right ToC under page in nav
+    - navigation.top
+    #- navigation.tabs -- We might use this for main HCC links like OOD
+  palette:
+
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+plugins:
+  - search
+  - macros
+  - social
+  - awesome-nav
+ # - table-reader
+  - include-markdown
+  - mkdocs-nav-weight:
+      section_renamed: false
+      index_weight: -10
+      warning: true
+      reverse: false
+      headless_included: false
+
+markdown_extensions:
+  - toc:
+      permalink: true
+  - abbr
+  - attr_list
+  - md_in_html
+  - def_list
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - admonition
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.magiclink
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.tabbed:
+      alternate_style: true
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower
+  - tables
+
+extra:
+  hcc:
+    # General HCC Links and Info
+    support_email: "hcc-support@unl.edu" 
+    website: "https://hcc.unl.edu"
+    status_page: "https://status.hcc.unl.edu"
+    ooh:
+      page: "https://hcc.unl.edu/ooh"
+      zoom: "http://go.unl.edu/HCChelp"
+      hours: "every Tuesday and Thursday from 2-3 PM central"
+    
+    # Swan Cluster Specific Information
+    swan:
+      partition:
+        default: batch
+        gpu: gpu
+      qos_limits:
+        normal: 
+          time: 7 days
+          cpu_per_user: 2000
+          jobs_per_user: 1000
+        short:
+          name: short
+          time: 6 hours
+          cpu_per_user: 16
+          jobs_per_user: 2
+      xfer: "swan-xfer.unl.edu"
+      ood:
+        name: "Swan Open OnDemand"
+        url: "https://swan-ood.unl.edu"
+      work:
+        block: "100 TiB"
+        inode: "5 Million"
+        purge: "6 Months"
+        path: "/work"
+        variable: "$WORK"
+      home:
+        block: "20 GiB"
+        inode: "1 Million"
+        purge: "None"
+        path: "/home"
+        variable: "$HOME"
+    # Anvil Cloud Information
+    anvil:
+        dashboard: "https://anvil.unl.edu/"
+        limits:
+          standard:
+            instance_count: "10"
+            cores: "20"
+            ram: "60 GB"
+            volume_count: "10"
+            volume_quota: "100 GB"
+          extended:
+              instance_count: "20"
+              cores: "40"
+              ram: "120 GB"
+              volume_count: "20"
+              volume_quota: "200 GB"
+    # Attic Archive Information
+    attic: 
+      xfer: "swan-xfer.unl.edu"
+      price: "$28 / TB / Year"
+    # Common Filesystem Information  
+    common:
+      block: "50 TiB"
+      inode: "5 Million"
+      purge: "None"
+      path: "/common"
+      variable: "$COMMON"
+      retirement_date: "July 1st, 2025"
+
+    # NRDStor Filesystem Information
+    nrdstor:
+      block: "50 TiB"
+      inode: "5 Million"
+      purge: "None"
+      path: "/mnt/nrdstor/"
+      variable: "$NRDSTOR"
+      mac_address: "smb://nrdstor.unl.edu/nrdstor"
+      windows_address: "\\\\nrdstor.unl.edu\\nrdstor"
+      linux_address: "\\\\\\\\nrdstor.unl.edu\\\\nrdstor"
+  nrp:
+    base_url: https://nrp.ai
+    docs_url: https://nrp.ai/documentation
+    resources: 
+      url: https://portal.nrp.ai/resources
+
+  generator: true
+  social: 
+    - icon: material/home
+      name: Website
+      link: https://hcc.unl.edu
+    - icon: fontawesome/regular/envelope
+      name: Send us an email or ticket!
+      link: mailto:hcc-support@unl.edu
+    - icon: material/phone-classic
+      name: Call Us
+      link: tel:4024725041
+    - icon: simple/zoom
+      name: Open Office Hours Every Tuesday and Thursday from 2 to 3PM Central
+      link: http://go.unl.edu/HCChelp
+    - icon: simple/github
+      name: HCC Github
+      link: https://github.com/unlhcc
+    - icon: simple/gitlab
+      name: HCC UNL Gitlab
+      link: https://git.unl.edu/hcc
+
+
+extra_javascript:
+  - https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js
+  - https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.31.1/js/jquery.tablesorter.min.js
+  - https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.31.1/js/widgets/widget-pager.min.js
+  - https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.31.1/js/widgets/widget-filter.min.js
+  - js/sort-table.js  # For the generated tables
+  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
+  #- js/tablesort.js # For the standard markdown tables
+
+extra_css:
+  - https://mottie.github.io/tablesorter/css/theme.dropbox.css
+  - https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.31.1/css/jquery.tablesorter.pager.min.css
+  - https://cdnjs.cloudflare.com/ajax/libs/jquery.tablesorter/2.31.1/css/filter.formatter.min.css
+  - stylesheets/extra.css
+

overrides/main.html

+{% extends "base.html" %}
+
+
+
+{% block announce %}
+<h4>Filesystem Retirement - July 1, 2025 - More information on the <a href = "https://hcc.unl.edu/docs/FAQ/common_retirement/">Common Retirement FAQ page</a></h4>
+
+
+
+{% endblock %}
+
+

pandoc-build.sh

+#!/bin/bash
+
+# Make the facilities document use Times New Roman, for NSF reasons
+
+# Create a pandoc document, and change the font
+PANTMP=$(mktemp -d)
+pushd ${PANTMP}
+echo "hello world" | pandoc -o reference.docx
+unzip -q reference.docx word/theme/theme1.xml
+sed -i 's/Calibri/Times New Roman/' word/theme/theme1.xml
+sed -i 's/Cambria/Times New Roman/' word/theme/theme1.xml
+zip -q -r --move reference.docx word
+popd
+
+pandoc --reference-doc=${PANTMP}/reference.docx -s docs/facilities.md -o site/facilities.docx
+pandoc --reference-doc=${PANTMP}/reference.docx -s docs/static/markdown/class-guidelines.md -o site/class-guidelines.docx
+
+rm -rf ${PANTMP}

requirements.txt

+mkdocs==1.6.1
+mkdocs-awesome-nav==3.1.1
+mkdocs-get-deps==0.2.0
+mkdocs-include-markdown-plugin==7.1.5
+mkdocs-macros-plugin==1.3.7
+mkdocs-material==9.6.11
+mkdocs-material-extensions==1.3.1
+mkdocs-nav-weight==0.2.0
+mkdocs-table-reader-plugin==3.1.0
+mkdocs-material[imaging]