Fix formatting and update guides index page

splashkit · Aug 13, 2024 · 779d522 · 779d522
1 parent 20cd052
commit 779d522
Show file tree

Hide file tree

Showing 27 changed files with 30 additions and 26 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -76,22 +76,22 @@ export default defineConfig({
         {
           label: "Tutorials and Guides",
           collapsed: true,
-          items: [
-            { label: "Using SplashKit", autogenerate: { directory: "guides/0-using-splashkit", collapsed: false } },
-            { label: "Animations", autogenerate: { directory: "guides/animations", collapsed: false } },
-            { label: "Audio", autogenerate: { directory: "guides/audio", collapsed: false } },
-            { label: "Camera", autogenerate: { directory: "guides/camera", collapsed: false } },
-            { label: "Graphics", autogenerate: { directory: "guides/graphics", collapsed: false } },
-            { label: "Input", autogenerate: { directory: "guides/input", collapsed: false } },
-            { label: "Interface", autogenerate: { directory: "guides/interface", collapsed: false } },
-            { label: "Json", autogenerate: { directory: "guides/json", collapsed: false } },
-            { label: "Networking", autogenerate: { directory: "guides/networking", collapsed: false } },
-            { label: "Raspberry GPIO", autogenerate: { directory: "guides/raspberry", collapsed: false } },
-            { label: "Resource Bundles", autogenerate: { directory: "guides/resource_bundles", collapsed: false } },
-            { label: "Sprites", autogenerate: { directory: "guides/sprites", collapsed: false } },
-            { label: "Utilities", autogenerate: { directory: "guides/utilities", collapsed: false } },
-          ]
-          // autogenerate: { directory: "guides", collapsed: true },
+          // items: [
+          //   { label: "Using SplashKit", autogenerate: { directory: "guides/0-using-splashkit", collapsed: false } },
+          //   { label: "Animations", autogenerate: { directory: "guides/animations", collapsed: false } },
+          //   { label: "Audio", autogenerate: { directory: "guides/audio", collapsed: false } },
+          //   { label: "Camera", autogenerate: { directory: "guides/camera", collapsed: false } },
+          //   { label: "Graphics", autogenerate: { directory: "guides/graphics", collapsed: false } },
+          //   { label: "Input", autogenerate: { directory: "guides/input", collapsed: false } },
+          //   { label: "Interface", autogenerate: { directory: "guides/interface", collapsed: false } },
+          //   { label: "Json", autogenerate: { directory: "guides/json", collapsed: false } },
+          //   { label: "Networking", autogenerate: { directory: "guides/networking", collapsed: false } },
+          //   { label: "Raspberry GPIO", autogenerate: { directory: "guides/raspberry", collapsed: false } },
+          //   { label: "Resource Bundles", autogenerate: { directory: "guides/resource_bundles", collapsed: false } },
+          //   { label: "Sprites", autogenerate: { directory: "guides/sprites", collapsed: false } },
+          //   { label: "Utilities", autogenerate: { directory: "guides/utilities", collapsed: false } },
+          // ]
+          autogenerate: { directory: "guides", collapsed: true },
         },
         {
           label: "Usage Examples",

diff --git a/src/components/Guides.astro b/src/components/Guides.astro
@@ -9,7 +9,7 @@ interface Frontmatter {
   category?: string;
 }
 
-let posts = await Astro.glob<Frontmatter>("../content/docs/guides/*.mdx");
+let posts = await Astro.glob<Frontmatter>("../content/docs/guides/*/*.mdx");
 posts = posts.filter((post) => !post.file.endsWith("index.mdx"));
 
 let guides = posts.filter(

diff --git a/src/content/docs/api/index.mdx b/src/content/docs/api/index.mdx
@@ -1,5 +1,5 @@
 ---
-title: Index Routing Page
+title: API Documentation
 sidebar:
   hidden: true
 ---
@@ -11,7 +11,7 @@ SplashKit provides a versatile set of categories, encompassing graphics, audio,
 
 :::
 
-import Some from "../../../components/Api.astro";
+import ApiList from "../../../components/Api.astro";
 
-<Some>
-</Some>
+<ApiList>
+</ApiList>
diff --git a/...ent/docs/guides/raspberry/0-blink-led.mdx → ...ocs/guides/Raspberry GPIO/0-blink-led.mdx b/...ent/docs/guides/raspberry/0-blink-led.mdx → ...ocs/guides/Raspberry GPIO/0-blink-led.mdx
diff --git a/.../guides/raspberry/1-read-button-press.mdx → ...es/Raspberry GPIO/1-read-button-press.mdx b/.../guides/raspberry/1-read-button-press.mdx → ...es/Raspberry GPIO/1-read-button-press.mdx
diff --git a/...cs/guides/raspberry/2-pwm-control-led.mdx → ...ides/Raspberry GPIO/2-pwm-control-led.mdx b/...cs/guides/raspberry/2-pwm-control-led.mdx → ...ides/Raspberry GPIO/2-pwm-control-led.mdx
diff --git a/...guides/raspberry/3-pwm-button-control.mdx → ...s/Raspberry GPIO/3-pwm-button-control.mdx b/...guides/raspberry/3-pwm-button-control.mdx → ...s/Raspberry GPIO/3-pwm-button-control.mdx
diff --git a/...ocs/guides/raspberry/4-analog-signals.mdx → ...uides/Raspberry GPIO/4-analog-signals.mdx b/...ocs/guides/raspberry/4-analog-signals.mdx → ...uides/Raspberry GPIO/4-analog-signals.mdx
diff --git a/...rry/images/circuits/blink_led_circuit.jpg → ...PIO/images/circuits/blink_led_circuit.jpg b/...rry/images/circuits/blink_led_circuit.jpg → ...PIO/images/circuits/blink_led_circuit.jpg
diff --git a/...es/raspberry/images/circuits/blinkled.png → ...spberry GPIO/images/circuits/blinkled.png b/...es/raspberry/images/circuits/blinkled.png → ...spberry GPIO/images/circuits/blinkled.png
diff --git a/.../raspberry/images/circuits/buttonpush.png → ...berry GPIO/images/circuits/buttonpush.png b/.../raspberry/images/circuits/buttonpush.png → ...berry GPIO/images/circuits/buttonpush.png
diff --git a/...es/raspberry/images/circuits/joystick.png → ...spberry GPIO/images/circuits/joystick.png b/...es/raspberry/images/circuits/joystick.png → ...spberry GPIO/images/circuits/joystick.png
diff --git a/...erry/images/circuits/joystick_circuit.png → ...GPIO/images/circuits/joystick_circuit.png b/...erry/images/circuits/joystick_circuit.png → ...GPIO/images/circuits/joystick_circuit.png
diff --git a/...y/images/circuits/push_button_circuit.png → ...O/images/circuits/push_button_circuit.png b/...y/images/circuits/push_button_circuit.png → ...O/images/circuits/push_button_circuit.png
diff --git a/...raspberry/images/circuits/pwm_buttons.png → ...erry GPIO/images/circuits/pwm_buttons.png b/...raspberry/images/circuits/pwm_buttons.png → ...erry GPIO/images/circuits/pwm_buttons.png
diff --git a/...y/images/circuits/pwm_buttons_circuit.png → ...O/images/circuits/pwm_buttons_circuit.png b/...y/images/circuits/pwm_buttons_circuit.png → ...O/images/circuits/pwm_buttons_circuit.png
diff --git a/...uides/raspberry/images/ctrl-bit_table.png → .../Raspberry GPIO/images/ctrl-bit_table.png b/...uides/raspberry/images/ctrl-bit_table.png → .../Raspberry GPIO/images/ctrl-bit_table.png
diff --git a/...ides/raspberry/images/joystick_pinout.png → ...Raspberry GPIO/images/joystick_pinout.png b/...ides/raspberry/images/joystick_pinout.png → ...Raspberry GPIO/images/joystick_pinout.png
diff --git a/...uides/raspberry/images/mcp3008_pinout.png → .../Raspberry GPIO/images/mcp3008_pinout.png b/...uides/raspberry/images/mcp3008_pinout.png → .../Raspberry GPIO/images/mcp3008_pinout.png
diff --git a/...des/raspberry/images/transmit_details.png → ...aspberry GPIO/images/transmit_details.png b/...des/raspberry/images/transmit_details.png → ...aspberry GPIO/images/transmit_details.png
diff --git a/...dles/0-loading-resources-with-bundles.mdx → ...dles/0-loading-resources-with-bundles.mdx b/...dles/0-loading-resources-with-bundles.mdx → ...dles/0-loading-resources-with-bundles.mdx
diff --git a/...s/guides/0-using-splashkit/0-overview.mdx → ...ocs/guides/Using SplashKit/0-overview.mdx b/...s/guides/0-using-splashkit/0-overview.mdx → ...ocs/guides/Using SplashKit/0-overview.mdx
@@ -1,5 +1,7 @@
 ---
 title: Using SplashKit (Overview)
+sidebar:
+  order: 1
 ---
 
 import { LinkCard, CardGrid } from '@astrojs/starlight/components';

diff --git a/...-using-splashkit/1-splashkit-on-macos.mdx → .../Using SplashKit/1-splashkit-on-macos.mdx b/...-using-splashkit/1-splashkit-on-macos.mdx → .../Using SplashKit/1-splashkit-on-macos.mdx
diff --git a/...kit/2-splashkit-with-msys2-on-windows.mdx → ...Kit/2-splashkit-with-msys2-on-windows.mdx b/...kit/2-splashkit-with-msys2-on-windows.mdx → ...Kit/2-splashkit-with-msys2-on-windows.mdx
diff --git a/...shkit/3-splashkit-with-wsl-on-windows.mdx → ...shKit/3-splashkit-with-wsl-on-windows.mdx b/...shkit/3-splashkit-with-wsl-on-windows.mdx → ...shKit/3-splashkit-with-wsl-on-windows.mdx
diff --git a/...-using-splashkit/4-splashkit-on-linux.mdx → .../Using SplashKit/4-splashkit-on-linux.mdx b/...-using-splashkit/4-splashkit-on-linux.mdx → .../Using SplashKit/4-splashkit-on-linux.mdx
diff --git a/src/content/docs/guides/index.mdx b/src/content/docs/guides/index.mdx
@@ -1,7 +1,9 @@
 ---
-title: Index Routing Page
+title: Tutorials and Guides
 sidebar:
-  hidden: true
+  hidden: false
+  label: "Overview"
+  order: 0
 ---
 
 
@@ -11,7 +13,7 @@ SplashKit provides a versatile set of categories, encompassing graphics, audio,
 
 :::
 
-import Some from "../../../components/Guides.astro";
+import GuidesList from "../../../components/Guides.astro";
 
-<Some>
-</Some>
+<GuidesList>
+</GuidesList>