project-template/docs/quartz.layout.ts
Erich Blume 5c9f06c165 Add README and ensure TODO markers at all template customization points
Adds a README.md describing the template and how to fork it. Adds TODO
comments to Dagger config, Quartz config, and CI workflow where they
were missing. Adds a "First-Time Setup" section to CLAUDE.md that
instructs Claude to proactively suggest resolving TODOs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-03 19:25:14 -08:00

53 lines
1.4 KiB
TypeScript

import { PageLayout, SharedLayout } from "./quartz/cfg"
import * as Component from "./quartz/components"
/**
* Quartz layout configuration for project documentation
* See https://quartz.jzhao.xyz/layout
*/
// Components shared across all pages
export const sharedPageComponents: SharedLayout = {
head: Component.Head(),
header: [],
afterBody: [],
footer: Component.Footer({
links: {
"Repository": "https://CHANGEME.example.com/owner/repo", // TODO: Update to your repo URL
},
}),
}
// Components for pages that list posts (folder pages, tag pages)
export const defaultContentPageLayout: PageLayout = {
beforeBody: [
Component.Breadcrumbs(),
Component.ArticleTitle(),
Component.ContentMeta(),
Component.TagList(),
],
left: [
Component.PageTitle(),
Component.MobileOnly(Component.Spacer()),
Component.Search(),
Component.Darkmode(),
Component.DesktopOnly(Component.Explorer()),
],
right: [
Component.Graph(),
Component.DesktopOnly(Component.TableOfContents()),
Component.Backlinks(),
],
}
export const defaultListPageLayout: PageLayout = {
beforeBody: [Component.Breadcrumbs(), Component.ArticleTitle(), Component.ContentMeta()],
left: [
Component.PageTitle(),
Component.MobileOnly(Component.Spacer()),
Component.Search(),
Component.Darkmode(),
Component.DesktopOnly(Component.Explorer()),
],
right: [],
}