support config urls and direct config embedding in project lists

libs/types/src/content/templates/project-list.d.ts

@@ -1,4 +1,5 @@
 import type { EntryTagCollection } from '../entryTag'
+import type { EntryWithConfig, EntryWithContent } from './shared'
 
 /**
  * This describes aditional information about a project.
@@ -36,11 +37,17 @@ export type ProjectListingInfo = {
   thumbnailBackgroundSize?: string
 }
 
+export type ProjectEntries = { [key: string]:
+  & EntryWithContent
+  & EntryWithConfig<ProjectListingInfo>
+}
+
 export type ProjectList = {
   projects: { [key: string]: {
     config: string
     content: string
   }}
+  projects: ProjectEntries
   tags?: EntryTagCollection
   removeFromView?: boolean
 }

libs/types/src/content/templates/shared.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Denotes a listing entry that contains content,
+ * which can be defined either directly in the list
+ * or be defined in a separate file
+ */
+export type EntryWithContent = {
+  content?: string
+  contentUrl?: string
+}
+
+/**
+ * Denotes a listing entry that contains config,
+ * which can be defined either directly in the list
+ * or be defined in a separate file
+ */
+export type EntryWithConfig<T> = {
+  config?: T
+  configUrl?: string
+}

projects/frontend/src/utilities/fetch.ts

@@ -2,6 +2,11 @@ import DOMPurify from 'dompurify'
 import { marked } from 'marked'
 import yaml from 'js-yaml'
 
+import type {
+  EntryWithConfig,
+  EntryWithContent,
+} from '@goldenwere/mackenzii-types/src/content/templates/shared'
+
 /**
  * Config used for DOMPurify.
  * This config allows for most HTML elements and a handful of attributes
@@ -123,6 +128,36 @@ export const fetchAndParseMarkdown = async (path: string) => {
   return marked.parse(document)
 }
 
+/**
+ * Fetches content for an entry
+ * @param entry the entry whose content should be fetched
+ * @returns the markdown content for the entry
+ */
+export const fetchContent = async (entry: EntryWithContent) => {
+  if (!!entry.content) {
+    return entry.content
+  } else if (!!entry.contentUrl) {
+    return fetchAndParseMarkdown(entry.contentUrl)
+  }
+
+  return ''
+}
+
+/**
+ * Fetches config for an entry
+ * @param entry the entry whose config should be fetched
+ * @returns the config object for the entry
+ */
+export const fetchConfig = async <T>(entry: EntryWithConfig<T>) => {
+  if (!!entry.config) {
+    return entry.config as T
+  } else if (!!entry.configUrl) {
+    return fetchAndParseYaml(entry.configUrl) as T
+  }
+
+  return {} as T
+}
+
 /**
  * Fetches content type from an image
  * @param path the path of the file to check

projects/frontend/src/views/project/project-list.vue

@@ -6,7 +6,7 @@ import type {
   ProjectListDefinition,
 } from '@goldenwere/mackenzii-types'
 
-import { fetchAndParseYaml } from 'src/utilities/fetch'
+import { fetchAndParseYaml, fetchConfig } from 'src/utilities/fetch'
 import { getCurrentRoute } from 'src/utilities/vuetils'
 import { useRouteStore } from 'src/routes'
 
@@ -55,7 +55,7 @@ onMounted(async () => {
   projectIds.value = Object.keys(config.value.projects)
   for (let i = 0; i < projectIds.value.length; ++i) {
     const id = projectIds.value[i]
-    projects.value[id] = await fetchAndParseYaml(config.value.projects[id].config)
+    projects.value[id] = await fetchConfig(config.value.projects[id])
   }
   document.title = routeConfig.fullTitle
   ready.value = true

projects/frontend/src/views/project/project-view.vue

@@ -7,7 +7,7 @@ import type {
   RoutedWindow,
 } from '@goldenwere/mackenzii-types'
 
-import { fetchAndParseMarkdown, fetchAndParseYaml } from 'src/utilities/fetch'
+import { fetchAndParseYaml, fetchConfig, fetchContent } from 'src/utilities/fetch'
 import { getCurrentRoute } from 'src/utilities/vuetils'
 import { useRouteStore } from 'src/routes'
 
@@ -29,8 +29,8 @@ const routeSubConfig = routeStore._routes[currentRoute.path]
 
 onMounted(async () => {
   const config = await fetchAndParseYaml<ProjectList>(routeConfig.config)
-  info.value = await fetchAndParseYaml<ProjectListingInfo>(config.projects[currentRoute.query.id as string].config)
-  const md = await fetchAndParseMarkdown(config.projects[currentRoute.query.id as string].content)
+  info.value = await fetchConfig(config.projects[currentRoute.query.id as string])
+  const md = await fetchContent(config.projects[currentRoute.query.id as string])
   content.value = md
   document.title = routeSubConfig.fullTitle?.replace('$PROJECT', info.value.title)
   routeStore.setBreadcrumbs(currentRoute, info.value.title)