From 847e891c3b57d4ea26a646e5cd53daf50367f33a Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Wed, 19 Mar 2025 18:07:26 -0500
Subject: [PATCH 1/2] feat: support markdown code blocks by default
---
mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml b/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml
index 69d3962..f2243cf 100644
--- a/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml
+++ b/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml
@@ -13,6 +13,7 @@ hljs_languages:
- bash
- shell
- plaintext
+ - markdown
# "TACC" Theme Features
# cms_url: https://your.related-non-documentation.website
# cms_name: Your Related non-Documentation Website
From dd98185a4f343a1eb98e6cee53e12d6dd92f9701 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Wed, 19 Mar 2025 19:02:03 -0500
Subject: [PATCH 2/2] =?UTF-8?q?refactor!:=20cms=5F=20=E2=86=92=20portal=5F?=
=?UTF-8?q?=20+=20demo=20logo?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docs/clients/basic-example.md | 4 +-
docs/clients/ds-user-guide-example.md | 4 +-
docs/clients/tacc-docs-example.md | 4 +-
docs/configure.md | 8 ++--
mkdocs.yml | 6 +--
.../tacc_readthedocs/img/logo-tacc.svg | 1 +
mkdocs_tacc/tacc_readthedocs/img/logo.svg | 47 ++++++++++++++++++-
mkdocs_tacc/tacc_readthedocs/main.html | 4 +-
mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml | 5 +-
9 files changed, 65 insertions(+), 18 deletions(-)
create mode 100644 mkdocs_tacc/tacc_readthedocs/img/logo-tacc.svg
diff --git a/docs/clients/basic-example.md b/docs/clients/basic-example.md
index 1909916..7ffb3af 100644
--- a/docs/clients/basic-example.md
+++ b/docs/clients/basic-example.md
@@ -11,8 +11,8 @@ theme:
logo: img/your-logo.svg
navigation_depth: 4
# "TACC" Theme Features
- cms_url: https://your.related-non-documentation.website
- cms_name: Your Related non-Documentation Website
+ portal_url: https://your.related-non-documentation.website
+ portal_name: Your Related non-Documentation Website
nav_name: Documentation
```
diff --git a/docs/clients/ds-user-guide-example.md b/docs/clients/ds-user-guide-example.md
index 6848153..e6c867a 100644
--- a/docs/clients/ds-user-guide-example.md
+++ b/docs/clients/ds-user-guide-example.md
@@ -15,8 +15,8 @@ theme:
- python
- json
# "TACC" Theme Features
- cms_url: https://designsafe-ci.org/
- cms_name: designsafe-ci.org
+ portal_url: https://designsafe-ci.org/
+ portal_name: designsafe-ci.org
nav_name: User Guide
```
diff --git a/docs/clients/tacc-docs-example.md b/docs/clients/tacc-docs-example.md
index 1c602ab..a8e126e 100644
--- a/docs/clients/tacc-docs-example.md
+++ b/docs/clients/tacc-docs-example.md
@@ -14,8 +14,8 @@ theme:
analytics:
gtag: G-TRRRQZ0EHX
# "TACC" Theme Features
- cms_url: https://tacc.utexas.edu
- cms_name: tacc.utexas.edu
+ portal_url: https://tacc.utexas.edu
+ portal_name: tacc.utexas.edu
hljs_aliases:
- name: cmd-line
lang: bash
diff --git a/docs/configure.md b/docs/configure.md
index 47bd9cc..b0da23c 100644
--- a/docs/configure.md
+++ b/docs/configure.md
@@ -20,8 +20,8 @@ theme:
|--------|-------------|
| `hljs_aliases` | Custom language aliases for highlight.js code blocks |
| `nav_redirects` | Redirect nav links to external pages |
-| `cms_url` | URL of the related non-documentation website |
-| `cms_name` | Name of the related non-documentation website |
+| `portal_url` | URL of the related non-documentation website |
+| `portal_name` | Name of the related non-documentation website |
| `nav_name` | Custom name for the navigation section |
### Custom Language Aliases
@@ -57,8 +57,8 @@ Link to a related non-documentation website:
```yaml
theme:
name: tacc_readthedocs
- cms_url: https://your.related-non-documentation.website
- cms_name: Your Related non-Documentation Website
+ portal_url: https://your.related-non-documentation.website
+ portal_name: Your Related non-Documentation Website
```
### Navigation Name
diff --git a/mkdocs.yml b/mkdocs.yml
index 7452f91..08a3260 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -12,10 +12,10 @@ theme:
- shell
- markdown
# "ReadTheDocs" Theme Features
- logo: img/logo.svg
+ logo: img/logo-tacc.svg
# "TACC" Theme Features
- cms_url: https://github.com/TACC/mkdocs-tacc
- cms_name: TACC/mkdocs-tacc
+ portal_url: https://github.com/TACC/mkdocs-tacc
+ portal_name: TACC/mkdocs-tacc
nav:
- Getting Started:
diff --git a/mkdocs_tacc/tacc_readthedocs/img/logo-tacc.svg b/mkdocs_tacc/tacc_readthedocs/img/logo-tacc.svg
new file mode 100644
index 0000000..03be480
--- /dev/null
+++ b/mkdocs_tacc/tacc_readthedocs/img/logo-tacc.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/mkdocs_tacc/tacc_readthedocs/img/logo.svg b/mkdocs_tacc/tacc_readthedocs/img/logo.svg
index 03be480..ba395d2 100644
--- a/mkdocs_tacc/tacc_readthedocs/img/logo.svg
+++ b/mkdocs_tacc/tacc_readthedocs/img/logo.svg
@@ -1 +1,46 @@
-
\ No newline at end of file
+
+
diff --git a/mkdocs_tacc/tacc_readthedocs/main.html b/mkdocs_tacc/tacc_readthedocs/main.html
index 1f50978..d3f5001 100644
--- a/mkdocs_tacc/tacc_readthedocs/main.html
+++ b/mkdocs_tacc/tacc_readthedocs/main.html
@@ -74,8 +74,8 @@
{%- if config.theme.nav_name %}
{{ config.theme.nav_name }}
{%- endif %}
- {%- if config.theme.cms_url %}
- {{ config.theme.cms_name }}
+ {%- if config.theme.portal_url %}
+ {{ config.theme.portal_name }}
{%- endif %}
{# /TACC #}
{%- endblock %}
diff --git a/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml b/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml
index f2243cf..eb412ba 100644
--- a/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml
+++ b/mkdocs_tacc/tacc_readthedocs/mkdocs_theme.yml
@@ -5,6 +5,7 @@ static_templates:
locale: en
# "ReadTheDocs" Theme Features
+logo: img/logo.svg
# https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs
collapse_navigation: false
navigation_depth: 4
@@ -15,8 +16,8 @@ hljs_languages:
- plaintext
- markdown
# "TACC" Theme Features
-# cms_url: https://your.related-non-documentation.website
-# cms_name: Your Related non-Documentation Website
+portal_url: https://your-site.org
+portal_name: your-site.org
# nav_redirects:
# - from: /old-page/
# to: /new-page/