@brendonovich/kobalte__solidbase/src/default-theme/frontmatter.ts

Fully featured, fully customisable static site generation for SolidStart

import { createMemo } from "solid-js";
import { type BaseFrontmatter, useFrontmatter } from "../client/index.jsx";

export function useDefaultThemeFrontmatter() {
	const frontmatter = useFrontmatter<DefaultThemeFrontmatter>();

	return createMemo(() => {
		const data = frontmatter();
		if (!data) return data;

		data.editLink ??= true;
		data.lastUpdated ??= true;

		if (data?.layout === "home") {
			data.sidebar = false;
			data.footer = false;
			data.toc = false;
			data.prev = false;
			data.next = false;
			data.editLink = false;
			data.lastUpdated = false;
		}

		return data;
	});
}

export type RelativePageConfig =
	| string
	| false
	| {
		text?: string;
		link?: string;
	};

interface DefaultThemeBaseFrontmatter {
	sidebar?: boolean;
	footer?: boolean;
	toc?: boolean;
	prev?: RelativePageConfig;
	next?: RelativePageConfig;
	editLink?: boolean;
	lastUpdated?: boolean;
}

interface HeroActionConfig {
	theme?: string;
	text?: string;
	link?: string;
}

export interface HeroConfig {
	name?: string;
	text?: string;
	tagline?: string;
	image?: {
		src: string;
		alt?: string;
	};
	actions?: Array<HeroActionConfig>;
}

export interface FeaturesConfig {
	icon?: string;
	title?: string;
	details?: string;
}

interface HomeLayoutFrontmatter {
	layout?: "home";
	hero?: HeroConfig;
	features?: Array<FeaturesConfig>;
}

export type DefaultThemeFrontmatter = (BaseFrontmatter &
	DefaultThemeBaseFrontmatter) &
	HomeLayoutFrontmatter;