fix: Cleaning up docs bugs (#3856)

* fix: Fixing code fence title for overview * fix: Use light and dark logos for opposing themes * fix: Don't use relative asset paths
gruntwork-io · Feb 7, 2025 · c040e19 · c040e19
1 parent 7c9f208
commit c040e19
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/docs-starlight/astro.config.mjs b/docs-starlight/astro.config.mjs
@@ -9,7 +9,8 @@ export default defineConfig({
 		starlight({
 			title: 'Terragrunt',
 			logo: {
-				src: '/src/assets/logo.svg',
+				dark: '/src/assets/logo-light.svg',
+				light: '/src/assets/logo-dark.svg',
 			},
 			social: {
 				github: 'https://github.com/gruntwork-io/terragrunt',

diff --git a/docs-starlight/src/assets/logo-dark.svg b/docs-starlight/src/assets/logo-dark.svg
diff --git a/docs-starlight/src/assets/logo.svg → docs-starlight/src/assets/logo-light.svg b/docs-starlight/src/assets/logo.svg → docs-starlight/src/assets/logo-light.svg
diff --git a/docs-starlight/src/content/docs/01-getting-started/02-overview.mdx b/docs-starlight/src/content/docs/01-getting-started/02-overview.mdx
@@ -37,6 +37,8 @@ If you don't have an AWS account, you can either sign up for a free tier account
 Here is a typical `terragrunt.hcl` file you might find in a Terragrunt project\*:
 
 ```hcl
+# terragrunt.hcl
+
 # Configure the remote backend
 remote_state {
   backend = "s3"

diff --git a/docs-starlight/src/content/docs/index.mdx b/docs-starlight/src/content/docs/index.mdx
@@ -5,7 +5,8 @@ template: splash
 hero:
   tagline: Flexible orchestrator to scale IaC.
   image:
-    file: ../../assets/logo.svg
+    dark: /src/assets/logo-light.svg
+    light: /src/assets/logo-dark.svg
   actions:
     - text: Quick Start
       link: /docs/getting-started/quick-start