Skip to content

Commit

Permalink
docs: Enable dark mode, add Nutanix color, and header links (#915)
Browse files Browse the repository at this point in the history
**What problem does this PR solve?**:

Add dark mode to docs just to be cool 😎 

<img width="1701" alt="image"
src="https://github.com/user-attachments/assets/ac41a749-982a-4206-941f-2b83f94d4d9d">

<img width="1689" alt="image"
src="https://github.com/user-attachments/assets/ef9c888e-f019-4bb0-a8a9-2065782ab0c4">

**Which issue(s) this PR fixes**:
Fixes #

**How Has This Been Tested?**:
<!--
Please describe the tests that you ran to verify your changes.
Provide output from the tests and any manual steps needed to replicate
the tests.
-->

**Special notes for your reviewer**:
<!--
Use this to provide any additional information to the reviewers.
This may include:
- Best way to review the PR.
- Where the author wants the most review attention on.
- etc.
-->
  • Loading branch information
jimmidyson authored Sep 25, 2024
1 parent a85f32f commit fc5213c
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import 'td/code-dark'
1 change: 1 addition & 0 deletions docs/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$primary: #7855FA;
9 changes: 6 additions & 3 deletions docs/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ anchor = "Smart"
typographer = false
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
[markup.highlight]
noClasses = false # Required for dark-mode
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "tango"
# style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

Expand Down Expand Up @@ -97,7 +98,7 @@ offlineSearch = true

# Enable syntax highlighting and copy buttons on code blocks with Prism
# Default "Chroma" syntax highlighter has no dot support, so use Prism instead
prism_syntax_highlighting = true
prism_syntax_highlighting = false

# User interface configuration
[params.ui]
Expand All @@ -120,6 +121,8 @@ sidebar_menu_foldable = true

sidebar_cache_limit = 1000

showLightDarkModeMenu = true

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
Expand Down
1 change: 1 addition & 0 deletions docs/layouts/_default/_markup/render-heading.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ template "_default/_markup/td-render-heading.html" . }}

0 comments on commit fc5213c

Please sign in to comment.