Add route for sound reference

davepagurek · davepagurek · commit f868d6b7df38 · 2024-10-10T17:03:47.000-04:00
diff --git a/src/content/pages/en/p5-sound-reference.mdx b/src/content/pages/en/p5-sound-reference.mdx
@@ -0,0 +1,5 @@
+---
+title: p5.sound Reference
+---
+
+Looking for the main p5.js reference? Go to <a href="/reference/">the reference</a>!
diff --git a/src/content/pages/en/reference.mdx b/src/content/pages/en/reference.mdx
@@ -2,4 +2,4 @@
 title: Reference
 ---
 
-Looking for p5.sound? Go to the <a href="https://archive.p5js.org/reference/#/libraries/p5.sound">p5.sound reference</a>!
+Looking for p5.sound? Go to the <a href="/reference/p5.sound/">p5.sound reference</a>!
diff --git a/src/content/reference/config.ts b/src/content/reference/config.ts
@@ -21,7 +21,6 @@ export const categories = [
   "Structure", // TODO: move to top once revised
   "Constants",
   "Foundation",
-  "p5.sound",
 ] as const;
 
 const paramSchema = z.object({
diff --git a/src/content/ui/en.yaml b/src/content/ui/en.yaml
@@ -46,6 +46,7 @@ No Results: No entries found for that search.
 No alt text: No alt text
 briefPageDescriptions:
   Reference: Find easy explanations for every piece of p5.js code.
+  p5.sound Reference: Extend p5.js with Web Audio functionality including audio input, playback, analysis and synthesis.
   Examples: Explore the possibilities of p5.js with short examples.
   Tutorials: Start from scratch or expand your skills with step-by-step lessons in p5.js.
   Contribute: Get involved with p5.js—create, code, document, donate, teach, and more!
diff --git a/src/globals/globals.ts b/src/globals/globals.ts
@@ -1,4 +1,4 @@
-import { p5Version } from "./p5-version";
+import { p5Version, p5SoundVersion } from "./p5-version";
 
 export const contentTypes = [
   "contributor-docs",
@@ -22,4 +22,4 @@ export const libraryDownloadUrl =
 export const minifiedLibraryDownloadUrl =
   `https://github.com/processing/p5.js/releases/download/v${p5Version}/p5.min.js` as const;
 export const cdnSoundUrl =
-  `https://cdn.jsdelivr.net/npm/p5@${p5Version}/lib/addons/p5.sound.js` as const;
+  `https://cdn.jsdelivr.net/npm/p5.sound.js@${p5SoundVersion}` as const;
diff --git a/src/globals/p5-version.ts b/src/globals/p5-version.ts
@@ -1 +1,2 @@
 export const p5Version = "1.11.0" as const;
+export const p5SoundVersion = "0.1.0" as const;
diff --git a/src/layouts/BaseLayout.astro b/src/layouts/BaseLayout.astro
@@ -38,7 +38,7 @@ const {
 
 const currentLocale = getCurrentLocale(Astro.url.pathname);
 
-const slug = title.toLowerCase().split(/\s+/).join('-');
+const slug = title.toLowerCase().split(/\s+|\./).join('-');
 const pages = await getCollectionInLocaleWithFallbacks("pages", currentLocale);
 const headerPage = pages.find((page) => removeLocalePrefix(page.slug).slice(1) === slug);
 let HeaderContent: any = undefined;
diff --git a/src/layouts/ReferenceLayout.astro b/src/layouts/ReferenceLayout.astro
@@ -22,6 +22,7 @@ import {
 interface Props {
   title: string;
   entries: CollectionEntry<"reference">[];
+  categories?: string[];
 }
 
 function strCompare(a: string, b: string) {
@@ -40,7 +41,7 @@ const uiTranslations = await getUiTranslationWithFallback(currentLocale);
 
 const { entries } = Astro.props;
 
-const categoryData = categories.map((category) => {
+const categoryData = (Astro.props.categories ?? categories).map((category) => {
   // Get all reference entries in the module
   const directEntries = entries.filter(
     (e) => e.data.module === t("referenceCategories", "modules", category)
@@ -135,7 +136,11 @@ const categoryData = categories.map((category) => {
   };
 });
 
-const pageJumpToLinks: JumpToLink[] = categoryData.map((category) => ({
+const jumpCategoryData = categoryData.length === 1
+  ? [...categoryData, ...categoryData[0].subcats]
+  : categoryData;
+
+const pageJumpToLinks: JumpToLink[] = jumpCategoryData.map((category) => ({
   label: category.name as string,
   url: `#${category.name}`,
 }));
@@ -147,9 +152,9 @@ const pageJumpToState: JumpToState = {
 setJumpToState(pageJumpToState);
 ---
 
-<Head title="Reference" locale={currentLocale} />
+<Head title={Astro.props.title} locale={currentLocale} />
 
-<BaseLayout title="Reference" mainContentParentClass="mx-0">
+<BaseLayout title={Astro.props.title} mainContentParentClass="mx-0">
   <ReferenceDirectoryWithFilter
     client:load
     categoryData={categoryData as any}
diff --git a/src/pages/reference/p5.sound.astro b/src/pages/reference/p5.sound.astro
@@ -0,0 +1,9 @@
+---
+import ReferenceLayout from "@layouts/ReferenceLayout.astro";
+import { getCollectionInDefaultLocale } from "@pages/_utils";
+
+const entries = await getCollectionInDefaultLocale("reference");
+const soundEntries = entries.filter((e) => e.data.module === 'p5.sound')
+---
+
+<ReferenceLayout title="p5.sound Reference" entries={soundEntries} categories={['p5.sound']} />

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +title: p5.sound Reference
 +---
++
 +Looking for the main p5.js reference? Go to <a href="/reference/">the reference</a>!
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`export const p5Version = "1.11.0" as const;`
	`2`	`+export const p5SoundVersion = "0.1.0" as const;`