Revert images, add links to headers in manual

.github/workflows/surge-xt-manual-pdf.yml

@@ -1,9 +1,9 @@
 name: Surge XT Manual PDF
 
 on:
-  push:
-    paths:
-      - "src/content/manual_xt/**.mdx"
+  # push:
+  #   paths:
+  #     - "src/content/manual_xt/**.mdx"
   workflow_dispatch:
 
 permissions:

astro.config.ts

@@ -2,10 +2,28 @@ import { defineConfig } from "astro/config";
 import mdx from "@astrojs/mdx";
 import react from "@astrojs/react";
 import tailwind from "@astrojs/tailwind";
+import remarkToc from "remark-toc";
+import { rehypeHeadingIds } from "@astrojs/markdown-remark";
+import rehypeSlug from "rehype-slug";
+import rehypeAutolinkHeadings from "rehype-autolink-headings";
 
 // https://astro.build/config
 export default defineConfig({
     markdown: {
+        remarkPlugins: [remarkToc],
+        rehypePlugins: [
+            rehypeHeadingIds,
+            rehypeSlug,
+            [
+                rehypeAutolinkHeadings,
+                {
+                    behavior: "wrap",
+                    properties: {
+                        className: `no-underline`,
+                    },
+                },
+            ],
+        ],
         shikiConfig: {
             theme: "css-variables",
             wrap: true,

package.json

@@ -10,6 +10,7 @@
         "preinstall": "astro telemetry disable"
     },
     "devDependencies": {
+        "@astrojs/markdown-remark": "latest",
         "@astrojs/mdx": "latest",
         "@astrojs/react": "latest",
         "@astrojs/tailwind": "latest",
@@ -27,6 +28,9 @@
         "prettier": "latest",
         "react-dom": "latest",
         "react": "latest",
+        "rehype-autolink-headings": "latest",
+        "rehype-slug": "latest",
+        "remark-toc": "latest",
         "rollup": "latest",
         "sharp": "latest",
         "shiki": "latest",

src/content/manual_xt/01-getting_started.mdx

@@ -4,7 +4,7 @@ slug: getting-started
 order: 1
 ---
 
-![](./images/manual-xt/Pictures/surge.png)
+![](/images/manual-xt/Pictures/surge.png)
 
 # Getting Started
 

src/content/manual_xt/03-user-interface-basics.mdx

@@ -15,7 +15,7 @@ The user-interface of Surge XT is divided into four main sections:
 
 Keeping this structure in mind will make it easier to understand the layout.
 
-![Illustration 1: The four sections the user-interface that Surge XT is divided into.](./images/manual-xt/Pictures/sections.png)
+![Illustration 1: The four sections the user-interface that Surge XT is divided into.](/images/manual-xt/Pictures/sections.png)
 
 _The four sections of the user-interface that Surge is divided into._
 
@@ -27,7 +27,7 @@ traditional synthesizer patch as it stores all the information used to synthesiz
 Since there are two scenes in each patch, it's possible to have layered or split sounds stored within a single patch.
 (see [Scene Select and Scene Mode](#scene-select-and-scene-mode)).
 
-![Illustration 2: Both scenes and all effect settings are stored in every patch.](./images/manual-xt/Pictures/illu2.png)
+![Illustration 2: Both scenes and all effect settings are stored in every patch.](/images/manual-xt/Pictures/illu2.png)
 
 ## Audio Outputs
 
@@ -72,7 +72,7 @@ Ctrl+Z and Ctrl+Y) to undo and redo respectively.
 
 Any parameter's context menu can be brought up with a right-click. This menu has numerous useful functions:
 
-![Illustration 3: Slider context menu](./images/manual-xt/Pictures/slider_context_menu.png)
+![Illustration 3: Slider context menu](/images/manual-xt/Pictures/slider_context_menu.png)
 
 #### Name and Contextual Help
 
@@ -87,12 +87,12 @@ confirm the change. To cancel and close this popup, simply press the Escape key
 
 Note that for any value type-in windows in Surge XT, there is no need to type in the unit of the entered value.
 
-![Illustration 4: Type-in window](./images/manual-xt/Pictures/typein_window.png)
+![Illustration 4: Type-in window](/images/manual-xt/Pictures/typein_window.png)
 
 For discrete parameters (Unison Voices, or a button row for instance), instead of a type-in field, all the possible
 values will be displayed right in the menu so they can be accessed directly.
 
-![Illustration 5: Discrete parameters](./images/manual-xt/Pictures/discrete_values.png)
+![Illustration 5: Discrete parameters](/images/manual-xt/Pictures/discrete_values.png)
 
 #### Extend Range
 
@@ -106,7 +106,7 @@ context menu if they do.
 
 Once tempo-synced, when using the Surge XT Classic skin, the slider will show a "TS" symbol on their handles to indicate that state, like so:
 
-![Illustration 6: Tempo sync slider](./images/manual-xt/Pictures/ts_slider.png)
+![Illustration 6: Tempo sync slider](/images/manual-xt/Pictures/ts_slider.png)
 
 This indication can vary depending on the skin used.
 

src/content/manual_xt/04-header.mdx

@@ -6,11 +6,11 @@ order: 4
 
 # Header
 
-![Illustration 7: Header section](./images/manual-xt/Pictures/header.png)
+![Illustration 7: Header section](/images/manual-xt/Pictures/header.png)
 
 ## Scene Select and Scene Mode
 
-![Illustration 8: Scene select and scene mode](./images/manual-xt/Pictures/scene_select.png)
+![Illustration 8: Scene select and scene mode](/images/manual-xt/Pictures/scene_select.png)
 
 There are two setups of all controls within the Scene section of the user interface.
 The **Scene Select** buttons **[A|B]** determine which one is selected for editing.
@@ -38,7 +38,7 @@ the limit.
 
 ## Patch Browser
 
-![Illustration 9: Patch browser](./images/manual-xt/Pictures/patchbrowser.png)
+![Illustration 9: Patch browser](/images/manual-xt/Pictures/patchbrowser.png)
 
 ### Navigation
 
@@ -89,7 +89,7 @@ close the search results.
 
 ### The Save Dialog
 
-![Illustration 10: Save dialog](./images/manual-xt/Pictures/store_dialog.png)
+![Illustration 10: Save dialog](/images/manual-xt/Pictures/store_dialog.png)
 
 Clicking the **Save** button of the patch browser opens the save dialog.
 This is where you name your new patch and choose which category it
@@ -110,7 +110,7 @@ Right-clicking on that same icon will allow you to access the favorite patches l
 
 ## Status Area
 
-![Illustration 11: Status area](./images/manual-xt/Pictures/status.png)
+![Illustration 11: Status area](/images/manual-xt/Pictures/status.png)
 
 This area is meant to be a quick access to some of Surge XT's features that are also present in the Menu.
 (see [Main Menu](#main-menu))
@@ -121,7 +121,7 @@ Left-clicking the Tune button while Surge XT is in its default tuning will also
 
 ## FX Bypass, Character, Global Volume
 
-![Illustration 12: FX bypass, character and global volume](./images/manual-xt/Pictures/fx_bypass.png)
+![Illustration 12: FX bypass, character and global volume](/images/manual-xt/Pictures/fx_bypass.png)
 
 **FX Bypass** lets you quickly hear what a patch sounds like without the effect-units. (see [Effects](#effects))