diff --git a/docs/advanced/making plugins.md b/docs/advanced/making plugins.md index 8ed533f..b65bd37 100644 --- a/docs/advanced/making plugins.md +++ b/docs/advanced/making plugins.md @@ -25,10 +25,11 @@ The following sections will go into detail for what methods can be implemented f - `BuildCtx` is defined in `quartz/ctx.ts`. It consists of - `argv`: The command line arguments passed to the Quartz [[build]] command - `cfg`: The full Quartz [[configuration]] - - `allSlugs`: a list of all the valid content slugs (see [[paths]] for more information on what a `ServerSlug` is) + - `allSlugs`: a list of all the valid content slugs (see [[paths]] for more information on what a slug is) - `StaticResources` is defined in `quartz/resources.tsx`. It consists of - `css`: a list of CSS style definitions that should be loaded. A CSS style is described with the `CSSResource` type which is also defined in `quartz/resources.tsx`. It accepts either a source URL or the inline content of the stylesheet. - `js`: a list of scripts that should be loaded. A script is described with the `JSResource` type which is also defined in `quartz/resources.tsx`. It allows you to define a load time (either before or after the DOM has been loaded), whether it should be a module, and either the source URL or the inline content of the script. + - `additionalHead`: a list of JSX elements or functions that return JSX elements to be added to the `` tag of the page. Functions receive the page's data as an argument and can conditionally render elements. ## Transformers @@ -234,7 +235,7 @@ export type WriteOptions = (data: { // the build context ctx: BuildCtx // the name of the file to emit (not including the file extension) - slug: ServerSlug + slug: FullSlug // the file extension ext: `.${string}` | "" // the file content to add diff --git a/docs/features/social images.md b/docs/features/social images.md index 0822651..d7f85b1 100644 --- a/docs/features/social images.md +++ b/docs/features/social images.md @@ -2,400 +2,18 @@ title: "Social Media Preview Cards" --- -A lot of social media platforms can display a rich preview for your website when sharing a link (most notably, a cover image, a title and a description). Quartz automatically handles most of this for you with reasonable defaults, but for more control, you can customize these by setting [[social images#Frontmatter Properties]]. -Quartz can also dynamically generate and use new cover images for every page to be used in link previews on social media for you. To get started with this, set `generateSocialImages: true` in `quartz.config.ts`. +A lot of social media platforms can display a rich preview for your website when sharing a link (most notably, a cover image, a title and a description). + +Quartz can also dynamically generate and use new cover images for every page to be used in link previews on social media for you. ## Showcase -After enabling `generateSocialImages` in `quartz.config.ts`, the social media link preview for [[authoring content | Authoring Content]] looks like this: +After enabling the [[CustomOgImages]] emitter plugin, the social media link preview for [[authoring content | Authoring Content]] looks like this: | Light | Dark | | ----------------------------------- | ---------------------------------- | | ![[social-image-preview-light.png]] | ![[social-image-preview-dark.png]] | -For testing, it is recommended to use [opengraph.xyz](https://www.opengraph.xyz/) to see what the link to your page will look like on various platforms (more info under [[social images#local testing]]). +## Configuration -## Customization - -You can customize how images will be generated in the quartz config. - -For example, here's what the default configuration looks like if you set `generateSocialImages: true`: - -```typescript title="quartz.config.ts" -generateSocialImages: { - colorScheme: "lightMode", // what colors to use for generating image, same as theme colors from config, valid values are "darkMode" and "lightMode" - width: 1200, // width to generate with (in pixels) - height: 630, // height to generate with (in pixels) - excludeRoot: false, // wether to exclude "/" index path to be excluded from auto generated images (false = use auto, true = use default og image) -} -``` - ---- - -### Frontmatter Properties - -> [!tip] Hint -> -> Overriding social media preview properties via frontmatter still works even if `generateSocialImages` is disabled. - -The following properties can be used to customize your link previews: - -| Property | Alias | Summary | -| ------------------- | ---------------- | ----------------------------------- | -| `socialDescription` | `description` | Description to be used for preview. | -| `socialImage` | `image`, `cover` | Link to preview image. | - -The `socialImage` property should contain a link to an image relative to `quartz/static`. If you have a folder for all your images in `quartz/static/my-images`, an example for `socialImage` could be `"my-images/cover.png"`. - -> [!info] Info -> -> The priority for what image will be used for the cover image looks like the following: `frontmatter property > generated image (if enabled) > default image`. -> -> The default image (`quartz/static/og-image.png`) will only be used as a fallback if nothing else is set. If `generateSocialImages` is enabled, it will be treated as the new default per page, but can be overwritten by setting the `socialImage` frontmatter property for that page. - ---- - -### Fully customized image generation - -You can fully customize how the images being generated look by passing your own component to `generateSocialImages.imageStructure`. This component takes html/css + some page metadata/config options and converts it to an image using [satori](https://github.com/vercel/satori). Vercel provides an [online playground](https://og-playground.vercel.app/) that can be used to preview how your html/css looks like as a picture. This is ideal for prototyping your custom design. - -It is recommended to write your own image components in `quartz/util/og.tsx` or any other `.tsx` file, as passing them to the config won't work otherwise. An example of the default image component can be found in `og.tsx` in `defaultImage()`. - -> [!tip] Hint -> -> Satori only supports a subset of all valid CSS properties. All supported properties can be found in their [documentation](https://github.com/vercel/satori#css). - -Your custom image component should have the `SocialImageOptions["imageStructure"]` type, to make development easier for you. Using a component of this type, you will be passed the following variables: - -```ts -imageStructure: ( - cfg: GlobalConfiguration, // global Quartz config (useful for getting theme colors and other info) - userOpts: UserOpts, // options passed to `generateSocialImage` - title: string, // title of current page - description: string, // description of current page - fonts: SatoriOptions["fonts"], // header + body font -) => JSXInternal.Element -``` - -Now, you can let your creativity flow and design your own image component! For reference and some cool tips, you can check how the markup for the default image looks. - -> [!example] Examples -> -> Here are some examples for markup you may need to get started: -> -> - Get a theme color -> -> `cfg.theme.colors[colorScheme].`, where `` corresponds to a key in `ColorScheme` (defined at the top of `quartz/util/theme.ts`) -> -> - Use the page title/description -> -> `

{title}

`/`

{description}

` -> -> - Use a font family -> -> Detailed in the Fonts chapter below - ---- - -### Fonts - -You will also be passed an array containing a header and a body font (where the first entry is header and the second is body). The fonts matches the ones selected in `theme.typography.header` and `theme.typography.body` from `quartz.config.ts` and will be passed in the format required by [`satori`](https://github.com/vercel/satori). To use them in CSS, use the `.name` property (e.g. `fontFamily: fonts[1].name` to use the "body" font family). - -An example of a component using the header font could look like this: - -```tsx title="socialImage.tsx" -export const myImage: SocialImageOptions["imageStructure"] = (...) => { - return

Cool Header!

-} -``` - -> [!example]- Local fonts -> -> For cases where you use a local fonts under `static` folder, make sure to set the correct `@font-face` in `custom.scss` -> -> ```scss title="custom.scss" -> @font-face { -> font-family: "Newsreader"; -> font-style: normal; -> font-weight: normal; -> font-display: swap; -> src: url("/static/Newsreader.woff2") format("woff2"); -> } -> ``` -> -> Then in `quartz/util/og.tsx`, you can load the satori fonts like so: -> -> ```tsx title="quartz/util/og.tsx" -> const headerFont = joinSegments("static", "Newsreader.woff2") -> const bodyFont = joinSegments("static", "Newsreader.woff2") -> -> export async function getSatoriFont(cfg: GlobalConfiguration): Promise { -> const headerWeight: FontWeight = 700 -> const bodyWeight: FontWeight = 400 -> -> const url = new URL(`https://${cfg.baseUrl ?? "example.com"}`) -> -> const [header, body] = await Promise.all( -> [headerFont, bodyFont].map((font) => -> fetch(`${url.toString()}/${font}`).then((res) => res.arrayBuffer()), -> ), -> ) -> -> return [ -> { name: cfg.theme.typography.header, data: header, weight: headerWeight, style: "normal" }, -> { name: cfg.theme.typography.body, data: body, weight: bodyWeight, style: "normal" }, -> ] -> } -> ``` -> -> This font then can be used with your custom structure - -### Local testing - -To test how the full preview of your page is going to look even before deploying, you can forward the port you're serving quartz on. In VSCode, this can easily be achieved following [this guide](https://code.visualstudio.com/docs/editor/port-forwarding) (make sure to set `Visibility` to `public` if testing on external tools like [opengraph.xyz](https://www.opengraph.xyz/)). - -If you have `generateSocialImages` enabled, you can check out all generated images under `public/static/social-images`. - -## Technical info - -Images will be generated as `.webp` files, which helps to keep images small (the average image takes ~`19kB`). They are also compressed further using [sharp](https://sharp.pixelplumbing.com/). - -When using images, the appropriate [Open Graph](https://ogp.me/) and [Twitter](https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started) meta tags will be set to ensure they work and look as expected. - -## Examples - -Besides the template for the default image generation (found under `quartz/util/og.tsx`), you can also add your own! To do this, you can either edit the source code of that file (not recommended) or create a new one (e.g. `customSocialImage.tsx`, source shown below). - -After adding that file, you can update `quartz.config.ts` to use your image generation template as follows: - -```ts -// Import component at start of file -import { customImage } from "./quartz/util/customSocialImage.tsx" - -// In main config -const config: QuartzConfig = { - ... - generateSocialImages: { - ... - imageStructure: customImage, // tells quartz to use your component when generating images - }, -} -``` - -The following example will generate images that look as follows: - -| Light | Dark | -| ------------------------------------------ | ----------------------------------------- | -| ![[custom-social-image-preview-light.png]] | ![[custom-social-image-preview-dark.png]] | - -This example (and the default template) use colors and fonts from your theme specified in the quartz config. Fonts get passed in as a prop, where `fonts[0]` will contain the header font and `fonts[1]` will contain the body font (more info in the [[#fonts]] section). - -```tsx -import { SatoriOptions } from "satori/wasm" -import { GlobalConfiguration } from "../cfg" -import { SocialImageOptions, UserOpts } from "./imageHelper" -import { QuartzPluginData } from "../plugins/vfile" - -export const customImage: SocialImageOptions["imageStructure"] = ( - cfg: GlobalConfiguration, - userOpts: UserOpts, - title: string, - description: string, - fonts: SatoriOptions["fonts"], - fileData: QuartzPluginData, -) => { - // How many characters are allowed before switching to smaller font - const fontBreakPoint = 22 - const useSmallerFont = title.length > fontBreakPoint - - const { colorScheme } = userOpts - return ( -
-
-

- {title} -

-

- {description} -

-
-
-
- ) -} -``` - -> [!example]- Advanced example -> -> The following example includes a customized social image with a custom background and formatted date. -> -> ```typescript title="custom-og.tsx" -> export const og: SocialImageOptions["Component"] = ( -> cfg: GlobalConfiguration, -> fileData: QuartzPluginData, -> { colorScheme }: Options, -> title: string, -> description: string, -> fonts: SatoriOptions["fonts"], -> ) => { -> let created: string | undefined -> let reading: string | undefined -> if (fileData.dates) { -> created = formatDate(getDate(cfg, fileData)!, cfg.locale) -> } -> const { minutes, text: _timeTaken, words: _words } = readingTime(fileData.text!) -> reading = i18n(cfg.locale).components.contentMeta.readingTime({ -> minutes: Math.ceil(minutes), -> }) -> -> const Li = [created, reading] -> -> return ( ->
style={{ -> position: "relative", -> display: "flex", -> flexDirection: "row", -> alignItems: "flex-start", -> height: "100%", -> width: "100%", -> backgroundImage: `url("https://${cfg.baseUrl}/static/og-image.jpeg")`, -> backgroundSize: "100% 100%", -> }} -> > ->
style={{ -> position: "absolute", -> top: 0, -> left: 0, -> right: 0, -> bottom: 0, -> background: "radial-gradient(circle at center, transparent, rgba(0, 0, 0, 0.4) 70%)", -> }} -> /> ->
style={{ -> display: "flex", -> height: "100%", -> width: "100%", -> flexDirection: "column", -> justifyContent: "flex-start", -> alignItems: "flex-start", -> gap: "1.5rem", -> paddingTop: "4rem", -> paddingBottom: "4rem", -> marginLeft: "4rem", -> }} -> > -> src={`"https://${cfg.baseUrl}/static/icon.jpeg"`} -> style={{ -> position: "relative", -> backgroundClip: "border-box", -> borderRadius: "6rem", -> }} -> width={80} -> /> ->
style={{ -> display: "flex", -> flexDirection: "column", -> textAlign: "left", -> fontFamily: fonts[0].name, -> }} -> > ->

style={{ -> color: cfg.theme.colors[colorScheme].light, -> fontSize: "3rem", -> fontWeight: 700, -> marginRight: "4rem", -> fontFamily: fonts[0].name, -> }} -> > -> {title} ->

->
    style={{ -> color: cfg.theme.colors[colorScheme].gray, -> gap: "1rem", -> fontSize: "1.5rem", -> fontFamily: fonts[1].name, -> }} -> > -> {Li.map((item, index) => { -> if (item) { -> return
  • {item}
    • -> } -> })} ->
->
->

style={{ -> color: cfg.theme.colors[colorScheme].light, -> fontSize: "1.5rem", -> overflow: "hidden", -> marginRight: "8rem", -> textOverflow: "ellipsis", -> display: "-webkit-box", -> WebkitLineClamp: 7, -> WebkitBoxOrient: "vertical", -> lineClamp: 7, -> fontFamily: fonts[1].name, -> }} -> > -> {description} ->

->
->
-> ) -> } -> ``` +This functionality is provided by the [[CustomOgImages]] plugin. See the plugin page for customization options. diff --git a/docs/plugins/CustomOgImages.md b/docs/plugins/CustomOgImages.md new file mode 100644 index 0000000..5d47c41 --- /dev/null +++ b/docs/plugins/CustomOgImages.md @@ -0,0 +1,360 @@ +--- +title: Custom OG Images +tags: + - feature/emitter +--- + +The Custom OG Images emitter plugin generates social media preview images for your pages. It uses [satori](https://github.com/vercel/satori) to convert HTML/CSS into images, allowing you to create beautiful and consistent social media preview cards for your content. + +> [!note] +> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page. + +## Features + +- Automatically generates social media preview images for each page +- Supports both light and dark mode themes +- Customizable through frontmatter properties +- Fallback to default image when needed +- Full control over image design through custom components + +## Configuration + +> [!info] Info +> +> The `baseUrl` property in your [[configuration]] must be set properly for social images to work correctly, as they require absolute paths. + +This plugin accepts the following configuration options: + +```typescript title="quartz.config.ts" +import { CustomOgImages } from "./quartz/plugins/emitters/ogImage" + +const config: QuartzConfig = { + plugins: { + emitters: [ + CustomOgImages({ + colorScheme: "lightMode", // what colors to use for generating image, same as theme colors from config, valid values are "darkMode" and "lightMode" + width: 1200, // width to generate with (in pixels) + height: 630, // height to generate with (in pixels) + excludeRoot: false, // wether to exclude "/" index path to be excluded from auto generated images (false = use auto, true = use default og image) + imageStructure: defaultImage, // custom image component to use + }), + ], + }, +} +``` + +### Configuration Options + +| Option | Type | Default | Description | +| ---------------- | --------- | ------------ | ----------------------------------------------------------------- | +| `colorScheme` | string | "lightMode" | Theme to use for generating images ("darkMode" or "lightMode") | +| `width` | number | 1200 | Width of the generated image in pixels | +| `height` | number | 630 | Height of the generated image in pixels | +| `excludeRoot` | boolean | false | Whether to exclude the root index page from auto-generated images | +| `imageStructure` | component | defaultImage | Custom component to use for image generation | + +## Frontmatter Properties + +The following properties can be used to customize your link previews: + +| Property | Alias | Summary | +| ------------------- | ---------------- | ----------------------------------- | +| `socialDescription` | `description` | Description to be used for preview. | +| `socialImage` | `image`, `cover` | Link to preview image. | + +The `socialImage` property should contain a link to an image relative to `quartz/static`. If you have a folder for all your images in `quartz/static/my-images`, an example for `socialImage` could be `"my-images/cover.png"`. + +> [!info] Info +> +> The priority for what image will be used for the cover image looks like the following: `frontmatter property > generated image (if enabled) > default image`. +> +> The default image (`quartz/static/og-image.png`) will only be used as a fallback if nothing else is set. If the Custom OG Images emitter plugin is enabled, it will be treated as the new default per page, but can be overwritten by setting the `socialImage` frontmatter property for that page. + +## Customization + +You can fully customize how the images being generated look by passing your own component to `imageStructure`. This component takes JSX + some page metadata/config options and converts it to an image using [satori](https://github.com/vercel/satori). Vercel provides an [online playground](https://og-playground.vercel.app/) that can be used to preview how your JSX looks like as a picture. This is ideal for prototyping your custom design. + +### Fonts + +You will also be passed an array containing a header and a body font (where the first entry is header and the second is body). The fonts matches the ones selected in `theme.typography.header` and `theme.typography.body` from `quartz.config.ts` and will be passed in the format required by [`satori`](https://github.com/vercel/satori). To use them in CSS, use the `.name` property (e.g. `fontFamily: fonts[1].name` to use the "body" font family). + +An example of a component using the header font could look like this: + +```tsx title="socialImage.tsx" +export const myImage: SocialImageOptions["imageStructure"] = (...) => { + return

Cool Header!

+} +``` + +> [!example]- Local fonts +> +> For cases where you use a local fonts under `static` folder, make sure to set the correct `@font-face` in `custom.scss` +> +> ```scss title="custom.scss" +> @font-face { +> font-family: "Newsreader"; +> font-style: normal; +> font-weight: normal; +> font-display: swap; +> src: url("/static/Newsreader.woff2") format("woff2"); +> } +> ``` +> +> Then in `quartz/util/og.tsx`, you can load the Satori fonts like so: +> +> ```tsx title="quartz/util/og.tsx" +> import { joinSegments, QUARTZ } from "../path" +> import fs from "fs" +> import path from "path" +> +> const newsreaderFontPath = joinSegments(QUARTZ, "static", "Newsreader.woff2") +> export async function getSatoriFonts(headerFont: FontSpecification, bodyFont: FontSpecification) { +> // ... rest of implementation remains same +> const fonts: SatoriOptions["fonts"] = [ +> ...headerFontData.map((data, idx) => ({ +> name: headerFontName, +> data, +> weight: headerWeights[idx], +> style: "normal" as const, +> })), +> ...bodyFontData.map((data, idx) => ({ +> name: bodyFontName, +> data, +> weight: bodyWeights[idx], +> style: "normal" as const, +> })), +> { +> name: "Newsreader", +> data: await fs.promises.readFile(path.resolve(newsreaderFontPath)), +> weight: 400, +> style: "normal" as const, +> }, +> ] +> +> return fonts +> } +> ``` +> +> This font then can be used with your custom structure. + +## Examples + +Here are some example image components you can use as a starting point: + +### Basic Example + +This example will generate images that look as follows: + +| Light | Dark | +| ------------------------------------------ | ----------------------------------------- | +| ![[custom-social-image-preview-light.png]] | ![[custom-social-image-preview-dark.png]] | + +```tsx +import { SatoriOptions } from "satori/wasm" +import { GlobalConfiguration } from "../cfg" +import { SocialImageOptions, UserOpts } from "./imageHelper" +import { QuartzPluginData } from "../plugins/vfile" + +export const customImage: SocialImageOptions["imageStructure"] = ( + cfg: GlobalConfiguration, + userOpts: UserOpts, + title: string, + description: string, + fonts: SatoriOptions["fonts"], + fileData: QuartzPluginData, +) => { + // How many characters are allowed before switching to smaller font + const fontBreakPoint = 22 + const useSmallerFont = title.length > fontBreakPoint + + const { colorScheme } = userOpts + return ( +
+
+

+ {title} +

+

+ {description} +

+
+
+
+ ) +} +``` + +### Advanced Example + +The following example includes a customized social image with a custom background and formatted date: + +```typescript title="custom-og.tsx" +export const og: SocialImageOptions["Component"] = ( + cfg: GlobalConfiguration, + fileData: QuartzPluginData, + { colorScheme }: Options, + title: string, + description: string, + fonts: SatoriOptions["fonts"], +) => { + let created: string | undefined + let reading: string | undefined + if (fileData.dates) { + created = formatDate(getDate(cfg, fileData)!, cfg.locale) + } + const { minutes, text: _timeTaken, words: _words } = readingTime(fileData.text!) + reading = i18n(cfg.locale).components.contentMeta.readingTime({ + minutes: Math.ceil(minutes), + }) + + const Li = [created, reading] + + return ( +
+
+
+ +
+

+ {title} +

+
    + {Li.map((item, index) => { + if (item) { + return
  • {item}
    • + } + })} +
+
+

+ {description} +

+
+
+ ) +} +``` diff --git a/package-lock.json b/package-lock.json index b887f5b..fff3180 100644 --- a/package-lock.json +++ b/package-lock.json @@ -75,7 +75,6 @@ "quartz": "quartz/bootstrap-cli.mjs" }, "devDependencies": { - "@types/cli-spinner": "^0.2.3", "@types/d3": "^7.4.3", "@types/hast": "^3.0.4", "@types/js-yaml": "^4.0.9", @@ -1585,15 +1584,6 @@ "integrity": "sha512-XKLA6syeBUaPzx4j3qwMqzzq+V4uo72BnlbOjmuljLrRqdsd3qnzvZZoxvMHZ23ndsRS4aufU6JOZYpCbU6T1A==", "license": "MIT" }, - "node_modules/@types/cli-spinner": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@types/cli-spinner/-/cli-spinner-0.2.3.tgz", - "integrity": "sha512-TMO6mWltW0lCu1de8DMRq9+59OP/tEjghS+rs8ZEQ2EgYP5yV3bGw0tS14TMyJGqFaoVChNvhkVzv9RC1UgX+w==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/css-font-loading-module": { "version": "0.0.12", "resolved": "https://registry.npmjs.org/@types/css-font-loading-module/-/css-font-loading-module-0.0.12.tgz", diff --git a/package.json b/package.json index 4ee8cfc..2e15874 100644 --- a/package.json +++ b/package.json @@ -98,7 +98,6 @@ "yargs": "^17.7.2" }, "devDependencies": { - "@types/cli-spinner": "^0.2.3", "@types/d3": "^7.4.3", "@types/hast": "^3.0.4", "@types/js-yaml": "^4.0.9", diff --git a/quartz.config.ts b/quartz.config.ts index 51a7551..5264b64 100644 --- a/quartz.config.ts +++ b/quartz.config.ts @@ -19,7 +19,6 @@ const config: QuartzConfig = { baseUrl: "quartz.jzhao.xyz", ignorePatterns: ["private", "templates", ".obsidian"], defaultDateType: "created", - generateSocialImages: true, theme: { fontOrigin: "googleFonts", cdnCaching: true, @@ -88,6 +87,7 @@ const config: QuartzConfig = { Plugin.Assets(), Plugin.Static(), Plugin.NotFoundPage(), + Plugin.CustomOgImages(), ], }, } diff --git a/quartz/build.ts b/quartz/build.ts index 81558f9..91a5a5a 100644 --- a/quartz/build.ts +++ b/quartz/build.ts @@ -250,15 +250,25 @@ async function partialRebuildFromEntrypoint( ([_node, vfile]) => !toRemove.has(vfile.data.filePath!), ) - const emittedFps = await emitter.emit(ctx, files, staticResources) - - if (ctx.argv.verbose) { - for (const file of emittedFps) { - console.log(`[emit:${emitter.name}] ${file}`) + const emitted = await emitter.emit(ctx, files, staticResources) + if (Symbol.asyncIterator in emitted) { + // Async generator case + for await (const file of emitted) { + emittedFiles++ + if (ctx.argv.verbose) { + console.log(`[emit:${emitter.name}] ${file}`) + } + } + } else { + // Array case + emittedFiles += emitted.length + if (ctx.argv.verbose) { + for (const file of emitted) { + console.log(`[emit:${emitter.name}] ${file}`) + } } } - emittedFiles += emittedFps.length continue } @@ -280,15 +290,24 @@ async function partialRebuildFromEntrypoint( .filter((file) => !toRemove.has(file)) .map((file) => contentMap.get(file)!) - const emittedFps = await emitter.emit(ctx, upstreamContent, staticResources) - - if (ctx.argv.verbose) { - for (const file of emittedFps) { - console.log(`[emit:${emitter.name}] ${file}`) + const emitted = await emitter.emit(ctx, upstreamContent, staticResources) + if (Symbol.asyncIterator in emitted) { + // Async generator case + for await (const file of emitted) { + emittedFiles++ + if (ctx.argv.verbose) { + console.log(`[emit:${emitter.name}] ${file}`) + } + } + } else { + // Array case + emittedFiles += emitted.length + if (ctx.argv.verbose) { + for (const file of emitted) { + console.log(`[emit:${emitter.name}] ${file}`) + } } } - - emittedFiles += emittedFps.length } } diff --git a/quartz/cfg.ts b/quartz/cfg.ts index 135f584..1c98b93 100644 --- a/quartz/cfg.ts +++ b/quartz/cfg.ts @@ -61,10 +61,6 @@ export interface GlobalConfiguration { * Quartz will avoid using this as much as possible and use relative URLs most of the time */ baseUrl?: string - /** - * Whether to generate social images (Open Graph and Twitter standard) for link previews - */ - generateSocialImages: boolean | Partial theme: Theme /** * Allow to translate the date in the language of your choice. diff --git a/quartz/components/Breadcrumbs.tsx b/quartz/components/Breadcrumbs.tsx index 9ccfb9a..d0faeab 100644 --- a/quartz/components/Breadcrumbs.tsx +++ b/quartz/components/Breadcrumbs.tsx @@ -102,7 +102,7 @@ export default ((opts?: Partial) => { // Add current slug to full path currentPath = joinSegments(currentPath, slugParts[i]) - const includeTrailingSlash = !isTagPath || i < 1 + const includeTrailingSlash = !isTagPath || i < slugParts.length - 1 // Format and add current crumb const crumb = formatCrumb( diff --git a/quartz/components/Head.tsx b/quartz/components/Head.tsx index b6a7e8d..60dce6e 100644 --- a/quartz/components/Head.tsx +++ b/quartz/components/Head.tsx @@ -1,173 +1,41 @@ import { i18n } from "../i18n" -import { FullSlug, joinSegments, pathToRoot } from "../util/path" +import { FullSlug, getFileExtension, joinSegments, pathToRoot } from "../util/path" import { CSSResourceToStyleElement, JSResourceToScriptElement } from "../util/resources" -import { getFontSpecificationName, googleFontHref } from "../util/theme" +import { googleFontHref } from "../util/theme" import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types" -import satori, { SatoriOptions } from "satori" -import { loadEmoji, getIconCode } from "../util/emoji" -import fs from "fs" -import sharp from "sharp" -import { ImageOptions, SocialImageOptions, getSatoriFont, defaultImage } from "../util/og" import { unescapeHTML } from "../util/escape" - -/** - * Generates social image (OG/twitter standard) and saves it as `.webp` inside the public folder - * @param opts options for generating image - */ -async function generateSocialImage( - { cfg, description, fileName, fontsPromise, title, fileData }: ImageOptions, - userOpts: SocialImageOptions, - imageDir: string, -) { - const fonts = await fontsPromise - const { width, height } = userOpts - - // JSX that will be used to generate satori svg - const imageComponent = userOpts.imageStructure(cfg, userOpts, title, description, fonts, fileData) - - const svg = await satori(imageComponent, { - width, - height, - fonts, - loadAdditionalAsset: async (languageCode: string, segment: string) => { - if (languageCode === "emoji") { - return `data:image/svg+xml;base64,${btoa(await loadEmoji(getIconCode(segment)))}` - } - - return languageCode - }, - }) - - // Convert svg directly to webp (with additional compression) - const compressed = await sharp(Buffer.from(svg)).webp({ quality: 40 }).toBuffer() - - // Write to file system - const filePath = joinSegments(imageDir, `${fileName}.${extension}`) - fs.writeFileSync(filePath, compressed) -} - -const extension = "webp" - -const defaultOptions: SocialImageOptions = { - colorScheme: "lightMode", - width: 1200, - height: 630, - imageStructure: defaultImage, - excludeRoot: false, -} - +import { CustomOgImagesEmitterName } from "../plugins/emitters/ogImage" export default (() => { - let fontsPromise: Promise - - let fullOptions: SocialImageOptions const Head: QuartzComponent = ({ cfg, fileData, externalResources, ctx, }: QuartzComponentProps) => { - // Initialize options if not set - if (!fullOptions) { - if (typeof cfg.generateSocialImages !== "boolean") { - fullOptions = { ...defaultOptions, ...cfg.generateSocialImages } - } else { - fullOptions = defaultOptions - } - } - - // Memoize google fonts - if (!fontsPromise && cfg.generateSocialImages) { - const headerFont = getFontSpecificationName(cfg.theme.typography.header) - const bodyFont = getFontSpecificationName(cfg.theme.typography.body) - fontsPromise = getSatoriFont(headerFont, bodyFont) - } - - const slug = fileData.filePath - // since "/" is not a valid character in file names, replace with "-" - const fileName = slug?.replaceAll("/", "-") - - // Get file description (priority: frontmatter > fileData > default) - const fdDescription = - fileData.description?.trim() ?? i18n(cfg.locale).propertyDefaults.description const titleSuffix = cfg.pageTitleSuffix ?? "" const title = (fileData.frontmatter?.title ?? i18n(cfg.locale).propertyDefaults.title) + titleSuffix - let description = "" - if (fdDescription) { - description = unescapeHTML(fdDescription) - } - - if (fileData.frontmatter?.socialDescription) { - description = fileData.frontmatter?.socialDescription as string - } else if (fileData.frontmatter?.description) { - description = fileData.frontmatter?.description - } - - const fileDir = joinSegments(ctx.argv.output, "static", "social-images") - if (cfg.generateSocialImages) { - // Generate folders for social images (if they dont exist yet) - if (!fs.existsSync(fileDir)) { - fs.mkdirSync(fileDir, { recursive: true }) - } - - if (fileName) { - // Generate social image (happens async) - void generateSocialImage( - { - title, - description, - fileName, - fileDir, - fileExt: extension, - fontsPromise, - cfg, - fileData, - }, - fullOptions, - fileDir, - ) - } - } + const description = + fileData.frontmatter?.socialDescription ?? + fileData.frontmatter?.description ?? + unescapeHTML(fileData.description?.trim() ?? i18n(cfg.locale).propertyDefaults.description) const { css, js, additionalHead } = externalResources const url = new URL(`https://${cfg.baseUrl ?? "example.com"}`) const path = url.pathname as FullSlug const baseDir = fileData.slug === "404" ? path : pathToRoot(fileData.slug!) - const iconPath = joinSegments(baseDir, "static/icon.png") - const ogImageDefaultPath = `https://${cfg.baseUrl}/static/og-image.png` - // "static/social-images/slug-filename.md.webp" - const ogImageGeneratedPath = `https://${cfg.baseUrl}/${fileDir.replace( - `${ctx.argv.output}/`, - "", - )}/${fileName}.${extension}` - - // Use default og image if filePath doesnt exist (for autogenerated paths with no .md file) - const useDefaultOgImage = fileName === undefined || !cfg.generateSocialImages - - // Path to og/social image (priority: frontmatter > generated image (if enabled) > default image) - let ogImagePath = useDefaultOgImage ? ogImageDefaultPath : ogImageGeneratedPath - - // TODO: could be improved to support external images in the future - // Aliases for image and cover handled in `frontmatter.ts` - const frontmatterImgUrl = fileData.frontmatter?.socialImage - - // Override with default og image if config option is set - if (fileData.slug === "index") { - ogImagePath = ogImageDefaultPath - } - - // Override with frontmatter url if existing - if (frontmatterImgUrl) { - ogImagePath = `https://${cfg.baseUrl}/static/${frontmatterImgUrl}` - } - // Url of current page const socialUrl = fileData.slug === "404" ? url.toString() : joinSegments(url.toString(), fileData.slug!) + const usesCustomOgImage = ctx.cfg.plugins.emitters.some( + (e) => e.name === CustomOgImagesEmitterName, + ) + const ogImageDefaultPath = `https://${cfg.baseUrl}/static/og-image.png` + return ( {title} @@ -181,7 +49,7 @@ export default (() => { )} - {/* OG/Twitter meta tags */} + @@ -189,28 +57,32 @@ export default (() => { - - {/* Dont set width and height if unknown (when using custom frontmatter image) */} - {!frontmatterImgUrl && ( + + {!usesCustomOgImage && ( <> - - + + + + )} - + {cfg.baseUrl && ( <> - - )} + + {css.map((resource) => CSSResourceToStyleElement(resource, true))} {js .filter((resource) => resource.loadTime === "beforeDOMReady") diff --git a/quartz/plugins/emitters/404.tsx b/quartz/plugins/emitters/404.tsx index 2d518b6..90c9d58 100644 --- a/quartz/plugins/emitters/404.tsx +++ b/quartz/plugins/emitters/404.tsx @@ -31,7 +31,7 @@ export const NotFoundPage: QuartzEmitterPlugin = () => { async getDependencyGraph(_ctx, _content, _resources) { return new DepGraph() }, - async emit(ctx, _content, resources): Promise { + async *emit(ctx, _content, resources) { const cfg = ctx.cfg.configuration const slug = "404" as FullSlug @@ -55,14 +55,12 @@ export const NotFoundPage: QuartzEmitterPlugin = () => { allFiles: [], } - return [ - await write({ - ctx, - content: renderPage(cfg, slug, componentData, opts, externalResources), - slug, - ext: ".html", - }), - ] + yield write({ + ctx, + content: renderPage(cfg, slug, componentData, opts, externalResources), + slug, + ext: ".html", + }) }, } } diff --git a/quartz/plugins/emitters/aliases.ts b/quartz/plugins/emitters/aliases.ts index 9d12a99..a16093b 100644 --- a/quartz/plugins/emitters/aliases.ts +++ b/quartz/plugins/emitters/aliases.ts @@ -18,15 +18,13 @@ export const AliasRedirects: QuartzEmitterPlugin = () => ({ return graph }, - async emit(ctx, content, _resources): Promise { - const fps: FilePath[] = [] - + async *emit(ctx, content, _resources) { for (const [_tree, file] of content) { const ogSlug = simplifySlug(file.data.slug!) for (const slug of file.data.aliases ?? []) { const redirUrl = resolveRelative(slug, file.data.slug!) - const fp = await write({ + yield write({ ctx, content: ` @@ -43,10 +41,7 @@ export const AliasRedirects: QuartzEmitterPlugin = () => ({ slug, ext: ".html", }) - - fps.push(fp) } } - return fps }, }) diff --git a/quartz/plugins/emitters/assets.ts b/quartz/plugins/emitters/assets.ts index bb85080..120d168 100644 --- a/quartz/plugins/emitters/assets.ts +++ b/quartz/plugins/emitters/assets.ts @@ -33,10 +33,9 @@ export const Assets: QuartzEmitterPlugin = () => { return graph }, - async emit({ argv, cfg }, _content, _resources): Promise { + async *emit({ argv, cfg }, _content, _resources) { const assetsPath = argv.output const fps = await filesToCopy(argv, cfg) - const res: FilePath[] = [] for (const fp of fps) { const ext = path.extname(fp) const src = joinSegments(argv.directory, fp) as FilePath @@ -46,10 +45,8 @@ export const Assets: QuartzEmitterPlugin = () => { const dir = path.dirname(dest) as FilePath await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists await fs.promises.copyFile(src, dest) - res.push(dest) + yield dest } - - return res }, } } diff --git a/quartz/plugins/emitters/cname.ts b/quartz/plugins/emitters/cname.ts index 380212d..897d851 100644 --- a/quartz/plugins/emitters/cname.ts +++ b/quartz/plugins/emitters/cname.ts @@ -14,7 +14,7 @@ export const CNAME: QuartzEmitterPlugin = () => ({ async getDependencyGraph(_ctx, _content, _resources) { return new DepGraph() }, - async emit({ argv, cfg }, _content, _resources): Promise { + async emit({ argv, cfg }, _content, _resources) { if (!cfg.configuration.baseUrl) { console.warn(chalk.yellow("CNAME emitter requires `baseUrl` to be set in your configuration")) return [] @@ -24,7 +24,7 @@ export const CNAME: QuartzEmitterPlugin = () => ({ if (!content) { return [] } - fs.writeFileSync(path, content) + await fs.promises.writeFile(path, content) return [path] as FilePath[] }, }) diff --git a/quartz/plugins/emitters/componentResources.ts b/quartz/plugins/emitters/componentResources.ts index 7584fdd..d4a3db7 100644 --- a/quartz/plugins/emitters/componentResources.ts +++ b/quartz/plugins/emitters/componentResources.ts @@ -9,7 +9,7 @@ import styles from "../../styles/custom.scss" import popoverStyle from "../../components/styles/popover.scss" import { BuildCtx } from "../../util/ctx" import { QuartzComponent } from "../../components/types" -import { googleFontHref, joinStyles } from "../../util/theme" +import { googleFontHref, joinStyles, processGoogleFonts } from "../../util/theme" import { Features, transform } from "lightningcss" import { transform as transpile } from "esbuild" import { write } from "./helpers" @@ -207,8 +207,7 @@ export const ComponentResources: QuartzEmitterPlugin = () => { async getDependencyGraph(_ctx, _content, _resources) { return new DepGraph() }, - async emit(ctx, _content, _resources): Promise { - const promises: Promise[] = [] + async *emit(ctx, _content, _resources) { const cfg = ctx.cfg.configuration // component specific scripts and styles const componentResources = getComponentResources(ctx) @@ -217,42 +216,35 @@ export const ComponentResources: QuartzEmitterPlugin = () => { // let the user do it themselves in css } else if (cfg.theme.fontOrigin === "googleFonts" && !cfg.theme.cdnCaching) { // when cdnCaching is true, we link to google fonts in Head.tsx - let match + const response = await fetch(googleFontHref(ctx.cfg.configuration.theme)) + googleFontsStyleSheet = await response.text() - const fontSourceRegex = /url\((https:\/\/fonts.gstatic.com\/s\/[^)]+\.(woff2|ttf))\)/g - - googleFontsStyleSheet = await ( - await fetch(googleFontHref(ctx.cfg.configuration.theme)) - ).text() - - while ((match = fontSourceRegex.exec(googleFontsStyleSheet)) !== null) { - // match[0] is the `url(path)`, match[1] is the `path` - const url = match[1] - // the static name of this file. - const [filename, ext] = url.split("/").pop()!.split(".") - - googleFontsStyleSheet = googleFontsStyleSheet.replace( - url, - `https://${cfg.baseUrl}/static/fonts/${filename}.ttf`, + if (!cfg.baseUrl) { + throw new Error( + "baseUrl must be defined when using Google Fonts without cfg.theme.cdnCaching", ) + } - promises.push( - fetch(url) - .then((res) => { - if (!res.ok) { - throw new Error(`Failed to fetch font`) - } - return res.arrayBuffer() - }) - .then((buf) => - write({ - ctx, - slug: joinSegments("static", "fonts", filename) as FullSlug, - ext: `.${ext}`, - content: Buffer.from(buf), - }), - ), - ) + const { processedStylesheet, fontFiles } = await processGoogleFonts( + googleFontsStyleSheet, + cfg.baseUrl, + ) + googleFontsStyleSheet = processedStylesheet + + // Download and save font files + for (const fontFile of fontFiles) { + const res = await fetch(fontFile.url) + if (!res.ok) { + throw new Error(`failed to fetch font ${fontFile.filename}`) + } + + const buf = await res.arrayBuffer() + yield write({ + ctx, + slug: joinSegments("static", "fonts", fontFile.filename) as FullSlug, + ext: `.${fontFile.extension}`, + content: Buffer.from(buf), + }) } } @@ -267,45 +259,42 @@ export const ComponentResources: QuartzEmitterPlugin = () => { ...componentResources.css, styles, ) + const [prescript, postscript] = await Promise.all([ joinScripts(componentResources.beforeDOMLoaded), joinScripts(componentResources.afterDOMLoaded), ]) - promises.push( - write({ - ctx, - slug: "index" as FullSlug, - ext: ".css", - content: transform({ - filename: "index.css", - code: Buffer.from(stylesheet), - minify: true, - targets: { - safari: (15 << 16) | (6 << 8), // 15.6 - ios_saf: (15 << 16) | (6 << 8), // 15.6 - edge: 115 << 16, - firefox: 102 << 16, - chrome: 109 << 16, - }, - include: Features.MediaQueries, - }).code.toString(), - }), - write({ + yield write({ + ctx, + slug: "index" as FullSlug, + ext: ".css", + content: transform({ + filename: "index.css", + code: Buffer.from(stylesheet), + minify: true, + targets: { + safari: (15 << 16) | (6 << 8), // 15.6 + ios_saf: (15 << 16) | (6 << 8), // 15.6 + edge: 115 << 16, + firefox: 102 << 16, + chrome: 109 << 16, + }, + include: Features.MediaQueries, + }).code.toString(), + }), + yield write({ ctx, slug: "prescript" as FullSlug, ext: ".js", content: prescript, }), - write({ + yield write({ ctx, slug: "postscript" as FullSlug, ext: ".js", content: postscript, - }), - ) - - return await Promise.all(promises) + }) }, } } diff --git a/quartz/plugins/emitters/contentIndex.tsx b/quartz/plugins/emitters/contentIndex.tsx index be460e5..6f43bad 100644 --- a/quartz/plugins/emitters/contentIndex.tsx +++ b/quartz/plugins/emitters/contentIndex.tsx @@ -117,9 +117,8 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { return graph }, - async emit(ctx, content, _resources) { + async *emit(ctx, content, _resources) { const cfg = ctx.cfg.configuration - const emitted: FilePath[] = [] const linkIndex: ContentIndexMap = new Map() for (const [tree, file] of content) { const slug = file.data.slug! @@ -142,25 +141,21 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { } if (opts?.enableSiteMap) { - emitted.push( - await write({ - ctx, - content: generateSiteMap(cfg, linkIndex), - slug: "sitemap" as FullSlug, - ext: ".xml", - }), - ) + yield write({ + ctx, + content: generateSiteMap(cfg, linkIndex), + slug: "sitemap" as FullSlug, + ext: ".xml", + }) } if (opts?.enableRSS) { - emitted.push( - await write({ - ctx, - content: generateRSSFeed(cfg, linkIndex, opts.rssLimit), - slug: (opts?.rssSlug ?? "index") as FullSlug, - ext: ".xml", - }), - ) + yield write({ + ctx, + content: generateRSSFeed(cfg, linkIndex, opts.rssLimit), + slug: (opts?.rssSlug ?? "index") as FullSlug, + ext: ".xml", + }) } const fp = joinSegments("static", "contentIndex") as FullSlug @@ -175,16 +170,12 @@ export const ContentIndex: QuartzEmitterPlugin> = (opts) => { }), ) - emitted.push( - await write({ - ctx, - content: JSON.stringify(simplifiedIndex), - slug: fp, - ext: ".json", - }), - ) - - return emitted + yield write({ + ctx, + content: JSON.stringify(simplifiedIndex), + slug: fp, + ext: ".json", + }) }, externalResources: (ctx) => { if (opts?.enableRSS) { diff --git a/quartz/plugins/emitters/contentPage.tsx b/quartz/plugins/emitters/contentPage.tsx index f59ff6b..8eb3e68 100644 --- a/quartz/plugins/emitters/contentPage.tsx +++ b/quartz/plugins/emitters/contentPage.tsx @@ -94,9 +94,8 @@ export const ContentPage: QuartzEmitterPlugin> = (userOp return graph }, - async emit(ctx, content, resources): Promise { + async *emit(ctx, content, resources) { const cfg = ctx.cfg.configuration - const fps: FilePath[] = [] const allFiles = content.map((c) => c[1].data) let containsIndex = false @@ -118,14 +117,12 @@ export const ContentPage: QuartzEmitterPlugin> = (userOp } const content = renderPage(cfg, slug, componentData, opts, externalResources) - const fp = await write({ + yield write({ ctx, content, slug, ext: ".html", }) - - fps.push(fp) } if (!containsIndex && !ctx.argv.fastRebuild) { @@ -135,8 +132,6 @@ export const ContentPage: QuartzEmitterPlugin> = (userOp ), ) } - - return fps }, } } diff --git a/quartz/plugins/emitters/folderPage.tsx b/quartz/plugins/emitters/folderPage.tsx index bafaec9..1c81207 100644 --- a/quartz/plugins/emitters/folderPage.tsx +++ b/quartz/plugins/emitters/folderPage.tsx @@ -69,8 +69,7 @@ export const FolderPage: QuartzEmitterPlugin> = (user return graph }, - async emit(ctx, content, resources): Promise { - const fps: FilePath[] = [] + async *emit(ctx, content, resources) { const allFiles = content.map((c) => c[1].data) const cfg = ctx.cfg.configuration @@ -119,16 +118,13 @@ export const FolderPage: QuartzEmitterPlugin> = (user } const content = renderPage(cfg, slug, componentData, opts, externalResources) - const fp = await write({ + yield write({ ctx, content, slug, ext: ".html", }) - - fps.push(fp) } - return fps }, } } diff --git a/quartz/plugins/emitters/helpers.ts b/quartz/plugins/emitters/helpers.ts index 523151c..6218178 100644 --- a/quartz/plugins/emitters/helpers.ts +++ b/quartz/plugins/emitters/helpers.ts @@ -2,12 +2,13 @@ import path from "path" import fs from "fs" import { BuildCtx } from "../../util/ctx" import { FilePath, FullSlug, joinSegments } from "../../util/path" +import { Readable } from "stream" type WriteOptions = { ctx: BuildCtx slug: FullSlug ext: `.${string}` | "" - content: string | Buffer + content: string | Buffer | Readable } export const write = async ({ ctx, slug, ext, content }: WriteOptions): Promise => { diff --git a/quartz/plugins/emitters/index.ts b/quartz/plugins/emitters/index.ts index 60f47fe..842ffb0 100644 --- a/quartz/plugins/emitters/index.ts +++ b/quartz/plugins/emitters/index.ts @@ -8,3 +8,4 @@ export { Static } from "./static" export { ComponentResources } from "./componentResources" export { NotFoundPage } from "./404" export { CNAME } from "./cname" +export { CustomOgImages } from "./ogImage" diff --git a/quartz/plugins/emitters/ogImage.tsx b/quartz/plugins/emitters/ogImage.tsx new file mode 100644 index 0000000..056976a --- /dev/null +++ b/quartz/plugins/emitters/ogImage.tsx @@ -0,0 +1,134 @@ +import { QuartzEmitterPlugin } from "../types" +import { i18n } from "../../i18n" +import { unescapeHTML } from "../../util/escape" +import { FullSlug, getFileExtension } from "../../util/path" +import { ImageOptions, SocialImageOptions, defaultImage, getSatoriFonts } from "../../util/og" +import sharp from "sharp" +import satori from "satori" +import { loadEmoji, getIconCode } from "../../util/emoji" +import { Readable } from "stream" +import { write } from "./helpers" + +const defaultOptions: SocialImageOptions = { + colorScheme: "lightMode", + width: 1200, + height: 630, + imageStructure: defaultImage, + excludeRoot: false, +} + +/** + * Generates social image (OG/twitter standard) and saves it as `.webp` inside the public folder + * @param opts options for generating image + */ +async function generateSocialImage( + { cfg, description, fonts, title, fileData }: ImageOptions, + userOpts: SocialImageOptions, +): Promise { + const { width, height } = userOpts + const imageComponent = userOpts.imageStructure(cfg, userOpts, title, description, fonts, fileData) + const svg = await satori(imageComponent, { + width, + height, + fonts, + loadAdditionalAsset: async (languageCode: string, segment: string) => { + if (languageCode === "emoji") { + return `data:image/svg+xml;base64,${btoa(await loadEmoji(getIconCode(segment)))}` + } + return languageCode + }, + }) + + return sharp(Buffer.from(svg)).webp({ quality: 40 }) +} + +export const CustomOgImagesEmitterName = "CustomOgImages" +export const CustomOgImages: QuartzEmitterPlugin> = (userOpts) => { + const fullOptions = { ...defaultOptions, ...userOpts } + + return { + name: CustomOgImagesEmitterName, + getQuartzComponents() { + return [] + }, + async *emit(ctx, content, _resources) { + const cfg = ctx.cfg.configuration + const headerFont = cfg.theme.typography.header + const bodyFont = cfg.theme.typography.body + const fonts = await getSatoriFonts(headerFont, bodyFont) + + for (const [_tree, vfile] of content) { + // if this file defines socialImage, we can skip + if (vfile.data.frontmatter?.socialImage !== undefined) { + continue + } + + const slug = vfile.data.slug! + const titleSuffix = cfg.pageTitleSuffix ?? "" + const title = + (vfile.data.frontmatter?.title ?? i18n(cfg.locale).propertyDefaults.title) + titleSuffix + const description = + vfile.data.frontmatter?.socialDescription ?? + vfile.data.frontmatter?.description ?? + unescapeHTML( + vfile.data.description?.trim() ?? i18n(cfg.locale).propertyDefaults.description, + ) + + const stream = await generateSocialImage( + { + title, + description, + fonts, + cfg, + fileData: vfile.data, + }, + fullOptions, + ) + + yield write({ + ctx, + content: stream, + slug: `${slug}-og-image` as FullSlug, + ext: ".webp", + }) + } + }, + externalResources: (ctx) => { + if (!ctx.cfg.configuration.baseUrl) { + return {} + } + + const baseUrl = ctx.cfg.configuration.baseUrl + return { + additionalHead: [ + (pageData) => { + const isRealFile = pageData.filePath !== undefined + const userDefinedOgImagePath = pageData.frontmatter?.socialImage + const generatedOgImagePath = isRealFile + ? `https://${baseUrl}/${pageData.slug!}-og-image.webp` + : undefined + const defaultOgImagePath = `https://${baseUrl}/static/og-image.png` + const ogImagePath = userDefinedOgImagePath ?? generatedOgImagePath ?? defaultOgImagePath + + const ogImageMimeType = `image/${getFileExtension(ogImagePath) ?? "png"}` + return ( + <> + {!userDefinedOgImagePath && ( + <> + + + + )} + + + + + + + ) + }, + ], + } + }, + } +} diff --git a/quartz/plugins/emitters/static.ts b/quartz/plugins/emitters/static.ts index 5545d2c..7c0ecfd 100644 --- a/quartz/plugins/emitters/static.ts +++ b/quartz/plugins/emitters/static.ts @@ -3,6 +3,7 @@ import { QuartzEmitterPlugin } from "../types" import fs from "fs" import { glob } from "../../util/glob" import DepGraph from "../../depgraph" +import { dirname } from "path" export const Static: QuartzEmitterPlugin = () => ({ name: "Static", @@ -20,13 +21,17 @@ export const Static: QuartzEmitterPlugin = () => ({ return graph }, - async emit({ argv, cfg }, _content, _resources): Promise { + async *emit({ argv, cfg }, _content) { const staticPath = joinSegments(QUARTZ, "static") const fps = await glob("**", staticPath, cfg.configuration.ignorePatterns) - await fs.promises.cp(staticPath, joinSegments(argv.output, "static"), { - recursive: true, - dereference: true, - }) - return fps.map((fp) => joinSegments(argv.output, "static", fp)) as FilePath[] + const outputStaticPath = joinSegments(argv.output, "static") + await fs.promises.mkdir(outputStaticPath, { recursive: true }) + for (const fp of fps) { + const src = joinSegments(staticPath, fp) as FilePath + const dest = joinSegments(outputStaticPath, fp) as FilePath + await fs.promises.mkdir(dirname(dest), { recursive: true }) + await fs.promises.copyFile(src, dest) + yield dest + } }, }) diff --git a/quartz/plugins/emitters/tagPage.tsx b/quartz/plugins/emitters/tagPage.tsx index 9913e7d..41cf091 100644 --- a/quartz/plugins/emitters/tagPage.tsx +++ b/quartz/plugins/emitters/tagPage.tsx @@ -71,8 +71,7 @@ export const TagPage: QuartzEmitterPlugin> = (userOpts) return graph }, - async emit(ctx, content, resources): Promise { - const fps: FilePath[] = [] + async *emit(ctx, content, resources) { const allFiles = content.map((c) => c[1].data) const cfg = ctx.cfg.configuration @@ -127,16 +126,13 @@ export const TagPage: QuartzEmitterPlugin> = (userOpts) } const content = renderPage(cfg, slug, componentData, opts, externalResources) - const fp = await write({ + yield write({ ctx, content, slug: file.data.slug!, ext: ".html", }) - - fps.push(fp) } - return fps }, } } diff --git a/quartz/plugins/transformers/frontmatter.ts b/quartz/plugins/transformers/frontmatter.ts index 9679bd1..b3a916a 100644 --- a/quartz/plugins/transformers/frontmatter.ts +++ b/quartz/plugins/transformers/frontmatter.ts @@ -131,6 +131,7 @@ declare module "vfile" { created: string published: string description: string + socialDescription: string publish: boolean | string draft: boolean | string lang: string diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts index e7cfb47..166ec5d 100644 --- a/quartz/plugins/types.ts +++ b/quartz/plugins/types.ts @@ -38,7 +38,11 @@ export type QuartzEmitterPlugin = ( ) => QuartzEmitterPluginInstance export type QuartzEmitterPluginInstance = { name: string - emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise + emit( + ctx: BuildCtx, + content: ProcessedContent[], + resources: StaticResources, + ): Promise | AsyncGenerator /** * Returns the components (if any) that are used in rendering the page. * This helps Quartz optimize the page by only including necessary resources diff --git a/quartz/processors/emit.ts b/quartz/processors/emit.ts index c68e0ed..0d3f8d7 100644 --- a/quartz/processors/emit.ts +++ b/quartz/processors/emit.ts @@ -4,6 +4,7 @@ import { ProcessedContent } from "../plugins/vfile" import { QuartzLogger } from "../util/log" import { trace } from "../util/trace" import { BuildCtx } from "../util/ctx" +import chalk from "chalk" export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) { const { argv, cfg } = ctx @@ -14,20 +15,36 @@ export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) { let emittedFiles = 0 const staticResources = getStaticResourcesFromPlugins(ctx) - for (const emitter of cfg.plugins.emitters) { - try { - const emitted = await emitter.emit(ctx, content, staticResources) - emittedFiles += emitted.length - - if (ctx.argv.verbose) { - for (const file of emitted) { - console.log(`[emit:${emitter.name}] ${file}`) + await Promise.all( + cfg.plugins.emitters.map(async (emitter) => { + try { + const emitted = await emitter.emit(ctx, content, staticResources) + if (Symbol.asyncIterator in emitted) { + // Async generator case + for await (const file of emitted) { + emittedFiles++ + if (ctx.argv.verbose) { + console.log(`[emit:${emitter.name}] ${file}`) + } else { + log.updateText(`Emitting output files: ${chalk.gray(file)}`) + } + } + } else { + // Array case + emittedFiles += emitted.length + for (const file of emitted) { + if (ctx.argv.verbose) { + console.log(`[emit:${emitter.name}] ${file}`) + } else { + log.updateText(`Emitting output files: ${chalk.gray(file)}`) + } + } } + } catch (err) { + trace(`Failed to emit from plugin \`${emitter.name}\``, err as Error) } - } catch (err) { - trace(`Failed to emit from plugin \`${emitter.name}\``, err as Error) - } - } + }), + ) log.end(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince()}`) } diff --git a/quartz/util/log.ts b/quartz/util/log.ts index 773945c..95015ac 100644 --- a/quartz/util/log.ts +++ b/quartz/util/log.ts @@ -1,26 +1,43 @@ -import { Spinner } from "cli-spinner" +import readline from "readline" export class QuartzLogger { verbose: boolean - spinner: Spinner | undefined + private spinnerInterval: NodeJS.Timeout | undefined + private spinnerText: string = "" + private spinnerIndex: number = 0 + private readonly spinnerChars = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"] + constructor(verbose: boolean) { this.verbose = verbose } start(text: string) { + this.spinnerText = text if (this.verbose) { console.log(text) } else { - this.spinner = new Spinner(`%s ${text}`) - this.spinner.setSpinnerString(18) - this.spinner.start() + this.spinnerIndex = 0 + this.spinnerInterval = setInterval(() => { + readline.clearLine(process.stdout, 0) + readline.cursorTo(process.stdout, 0) + process.stdout.write(`${this.spinnerChars[this.spinnerIndex]} ${this.spinnerText}`) + this.spinnerIndex = (this.spinnerIndex + 1) % this.spinnerChars.length + }, 100) } } + updateText(text: string) { + this.spinnerText = text + } + end(text?: string) { - if (!this.verbose) { - this.spinner!.stop(true) + if (!this.verbose && this.spinnerInterval) { + clearInterval(this.spinnerInterval) + this.spinnerInterval = undefined + readline.clearLine(process.stdout, 0) + readline.cursorTo(process.stdout, 0) } + if (text) { console.log(text) } diff --git a/quartz/util/og.tsx b/quartz/util/og.tsx index 4d675cb..c8ad663 100644 --- a/quartz/util/og.tsx +++ b/quartz/util/og.tsx @@ -1,28 +1,55 @@ +import { promises as fs } from "fs" import { FontWeight, SatoriOptions } from "satori/wasm" import { GlobalConfiguration } from "../cfg" import { QuartzPluginData } from "../plugins/vfile" import { JSXInternal } from "preact/src/jsx" -import { ThemeKey } from "./theme" +import { FontSpecification, ThemeKey } from "./theme" +import path from "path" +import { QUARTZ } from "./path" +import { formatDate } from "../components/Date" +import { getDate } from "../components/Date" -/** - * Get an array of `FontOptions` (for satori) given google font names - * @param headerFontName name of google font used for header - * @param bodyFontName name of google font used for body - * @returns FontOptions for header and body - */ -export async function getSatoriFont(headerFontName: string, bodyFontName: string) { - const headerWeight = 700 as FontWeight - const bodyWeight = 400 as FontWeight +const defaultHeaderWeight = [700] +const defaultBodyWeight = [400] +export async function getSatoriFonts(headerFont: FontSpecification, bodyFont: FontSpecification) { + // Get all weights for header and body fonts + const headerWeights: FontWeight[] = ( + typeof headerFont === "string" + ? defaultHeaderWeight + : (headerFont.weights ?? defaultHeaderWeight) + ) as FontWeight[] + const bodyWeights: FontWeight[] = ( + typeof bodyFont === "string" ? defaultBodyWeight : (bodyFont.weights ?? defaultBodyWeight) + ) as FontWeight[] - // Fetch fonts - const headerFont = await fetchTtf(headerFontName, headerWeight) - const bodyFont = await fetchTtf(bodyFontName, bodyWeight) + const headerFontName = typeof headerFont === "string" ? headerFont : headerFont.name + const bodyFontName = typeof bodyFont === "string" ? bodyFont : bodyFont.name + + // Fetch fonts for all weights + const headerFontPromises = headerWeights.map((weight) => fetchTtf(headerFontName, weight)) + const bodyFontPromises = bodyWeights.map((weight) => fetchTtf(bodyFontName, weight)) + + const [headerFontData, bodyFontData] = await Promise.all([ + Promise.all(headerFontPromises), + Promise.all(bodyFontPromises), + ]) // Convert fonts to satori font format and return const fonts: SatoriOptions["fonts"] = [ - { name: headerFontName, data: headerFont, weight: headerWeight, style: "normal" }, - { name: bodyFontName, data: bodyFont, weight: bodyWeight, style: "normal" }, + ...headerFontData.map((data, idx) => ({ + name: headerFontName, + data, + weight: headerWeights[idx], + style: "normal" as const, + })), + ...bodyFontData.map((data, idx) => ({ + name: bodyFontName, + data, + weight: bodyWeights[idx], + style: "normal" as const, + })), ] + return fonts } @@ -32,32 +59,49 @@ export async function getSatoriFont(headerFontName: string, bodyFontName: string * @param weight what font weight to fetch font * @returns `.ttf` file of google font */ -async function fetchTtf(fontName: string, weight: FontWeight): Promise { +export async function fetchTtf( + fontName: string, + weight: FontWeight, +): Promise> { + const cacheKey = `${fontName.replaceAll(" ", "-")}-${weight}` + const cacheDir = path.join(QUARTZ, ".quartz-cache", "fonts") + const cachePath = path.join(cacheDir, cacheKey) + + // Check if font exists in cache try { - // Get css file from google fonts - const cssResponse = await fetch( - `https://fonts.googleapis.com/css2?family=${fontName}:wght@${weight}`, - ) - const css = await cssResponse.text() - - // Extract .ttf url from css file - const urlRegex = /url\((https:\/\/fonts.gstatic.com\/s\/.*?.ttf)\)/g - const match = urlRegex.exec(css) - - if (!match) { - throw new Error("Could not fetch font") - } - - // Retrieve font data as ArrayBuffer - const fontResponse = await fetch(match[1]) - - // fontData is an ArrayBuffer containing the .ttf file data (get match[1] due to google fonts response format, always contains link twice, but second entry is the "raw" link) - const fontData = await fontResponse.arrayBuffer() - - return fontData + await fs.access(cachePath) + return fs.readFile(cachePath) } catch (error) { - throw new Error(`Error fetching font: ${error}`) + // ignore errors and fetch font } + + // Get css file from google fonts + const cssResponse = await fetch( + `https://fonts.googleapis.com/css2?family=${fontName}:wght@${weight}`, + ) + const css = await cssResponse.text() + + // Extract .ttf url from css file + const urlRegex = /url\((https:\/\/fonts.gstatic.com\/s\/.*?.ttf)\)/g + const match = urlRegex.exec(css) + + if (!match) { + throw new Error("Could not fetch font") + } + + // fontData is an ArrayBuffer containing the .ttf file data + const fontResponse = await fetch(match[1]) + const fontData = Buffer.from(await fontResponse.arrayBuffer()) + + try { + await fs.mkdir(cacheDir, { recursive: true }) + await fs.writeFile(cachePath, fontData) + } catch (error) { + console.warn(`Failed to cache font: ${error}`) + // Continue even if caching fails + } + + return fontData } export type SocialImageOptions = { @@ -108,22 +152,10 @@ export type ImageOptions = { * what description to use as body in image */ description: string - /** - * what fileName to use when writing to disk - */ - fileName: string - /** - * what directory to store image in - */ - fileDir: string - /** - * what file extension to use (should be `webp` unless you also change sharp conversion) - */ - fileExt: string /** * header + body font to be used when generating satori image (as promise to work around sync in component) */ - fontsPromise: Promise + fonts: SatoriOptions["fonts"] /** * `GlobalConfiguration` of quartz (used for theme/typography) */ @@ -141,68 +173,94 @@ export const defaultImage: SocialImageOptions["imageStructure"] = ( title: string, description: string, fonts: SatoriOptions["fonts"], - _fileData: QuartzPluginData, + fileData: QuartzPluginData, ) => { - const fontBreakPoint = 22 + const fontBreakPoint = 32 const useSmallerFont = title.length > fontBreakPoint const iconPath = `https://${cfg.baseUrl}/static/icon.png` + // Format date if available + const rawDate = getDate(cfg, fileData) + const date = rawDate ? formatDate(rawDate, cfg.locale) : null + + // Get tags if available + const tags = fileData.frontmatter?.tags ?? [] + return (
+ {/* Header Section */}
- +
-

- {title} -

+ {cfg.baseUrl}
+ + {/* Title Section */}
+

+ {title} +

+
+ + {/* Description Section */} +

{description}

+ + {/* Footer with Metadata */} +
+ {/* Left side - Date */} +
+ {date && ( +
+ + + + + + + {date} +
+ )} +
+ + {/* Right side - Tags */} +
+ {tags.slice(0, 3).map((tag: string) => ( +
+ #{tag} +
+ ))} +
+
) } diff --git a/quartz/util/path.ts b/quartz/util/path.ts index 8f85029..6d99c36 100644 --- a/quartz/util/path.ts +++ b/quartz/util/path.ts @@ -36,7 +36,7 @@ export type RelativeURL = SlugLike<"relative"> export function isRelativeURL(s: string): s is RelativeURL { const validStart = /^\.{1,2}/.test(s) const validEnding = !endsWith(s, "index") - return validStart && validEnding && ![".md", ".html"].includes(_getFileExtension(s) ?? "") + return validStart && validEnding && ![".md", ".html"].includes(getFileExtension(s) ?? "") } export function getFullSlug(window: Window): FullSlug { @@ -61,7 +61,7 @@ function sluggify(s: string): string { export function slugifyFilePath(fp: FilePath, excludeExt?: boolean): FullSlug { fp = stripSlashes(fp) as FilePath - let ext = _getFileExtension(fp) + let ext = getFileExtension(fp) const withoutFileExt = fp.replace(new RegExp(ext + "$"), "") if (excludeExt || [".md", ".html", undefined].includes(ext)) { ext = "" @@ -272,10 +272,10 @@ function containsForbiddenCharacters(s: string): boolean { } function _hasFileExtension(s: string): boolean { - return _getFileExtension(s) !== undefined + return getFileExtension(s) !== undefined } -function _getFileExtension(s: string): string | undefined { +export function getFileExtension(s: string): string | undefined { return s.match(/\.[A-Za-z0-9]+$/)?.[0] } diff --git a/quartz/util/theme.ts b/quartz/util/theme.ts index 8381cc7..56261e3 100644 --- a/quartz/util/theme.ts +++ b/quartz/util/theme.ts @@ -15,7 +15,7 @@ interface Colors { darkMode: ColorScheme } -type FontSpecification = +export type FontSpecification = | string | { name: string @@ -90,6 +90,36 @@ export function googleFontHref(theme: Theme) { return `https://fonts.googleapis.com/css2?family=${bodyFont}&family=${headerFont}&family=${codeFont}&display=swap` } +export interface GoogleFontFile { + url: string + filename: string + extension: string +} + +export async function processGoogleFonts( + stylesheet: string, + baseUrl: string, +): Promise<{ + processedStylesheet: string + fontFiles: GoogleFontFile[] +}> { + const fontSourceRegex = /url\((https:\/\/fonts.gstatic.com\/s\/[^)]+\.(woff2|ttf))\)/g + const fontFiles: GoogleFontFile[] = [] + let processedStylesheet = stylesheet + + let match + while ((match = fontSourceRegex.exec(stylesheet)) !== null) { + const url = match[1] + const [filename, extension] = url.split("/").pop()!.split(".") + const staticUrl = `https://${baseUrl}/static/fonts/${filename}.${extension}` + + processedStylesheet = processedStylesheet.replace(url, staticUrl) + fontFiles.push({ url, filename, extension }) + } + + return { processedStylesheet, fontFiles } +} + export function joinStyles(theme: Theme, ...stylesheet: string[]) { return ` ${stylesheet.join("\n\n")}