mirror of
https://github.com/jackyzha0/quartz.git
synced 2025-12-01 18:27:57 +01:00
Compare commits
19 Commits
c5a8b199ae
...
v4.5.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a737207981 | ||
|
|
a72b1a4224 | ||
|
|
fbb4523853 | ||
|
|
da1b6b37fe | ||
|
|
e26658f4ed | ||
|
|
b579950ae5 | ||
|
|
0babbdf780 | ||
|
|
1efe2e20a4 | ||
|
|
5928d82a56 | ||
|
|
696403d3fa | ||
|
|
2c30abe457 | ||
|
|
80c3196fee | ||
|
|
d9159e0ac9 | ||
|
|
c005fe4408 | ||
|
|
580c1bd608 | ||
|
|
270a5dc14a | ||
|
|
bfa938cc62 | ||
|
|
e3c50caf13 | ||
|
|
ca08ec1ae7 |
@@ -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
|
- `BuildCtx` is defined in `quartz/ctx.ts`. It consists of
|
||||||
- `argv`: The command line arguments passed to the Quartz [[build]] command
|
- `argv`: The command line arguments passed to the Quartz [[build]] command
|
||||||
- `cfg`: The full Quartz [[configuration]]
|
- `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
|
- `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.
|
- `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.
|
- `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 `<head>` tag of the page. Functions receive the page's data as an argument and can conditionally render elements.
|
||||||
|
|
||||||
## Transformers
|
## Transformers
|
||||||
|
|
||||||
@@ -220,12 +221,26 @@ export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
|
|||||||
|
|
||||||
export type QuartzEmitterPluginInstance = {
|
export type QuartzEmitterPluginInstance = {
|
||||||
name: string
|
name: string
|
||||||
emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
|
emit(
|
||||||
|
ctx: BuildCtx,
|
||||||
|
content: ProcessedContent[],
|
||||||
|
resources: StaticResources,
|
||||||
|
): Promise<FilePath[]> | AsyncGenerator<FilePath>
|
||||||
|
partialEmit?(
|
||||||
|
ctx: BuildCtx,
|
||||||
|
content: ProcessedContent[],
|
||||||
|
resources: StaticResources,
|
||||||
|
changeEvents: ChangeEvent[],
|
||||||
|
): Promise<FilePath[]> | AsyncGenerator<FilePath> | null
|
||||||
getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
|
getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
An emitter plugin must define a `name` field, an `emit` function, and a `getQuartzComponents` function. `emit` is responsible for looking at all the parsed and filtered content and then appropriately creating files and returning a list of paths to files the plugin created.
|
An emitter plugin must define a `name` field, an `emit` function, and a `getQuartzComponents` function. It can optionally implement a `partialEmit` function for incremental builds.
|
||||||
|
|
||||||
|
- `emit` is responsible for looking at all the parsed and filtered content and then appropriately creating files and returning a list of paths to files the plugin created.
|
||||||
|
- `partialEmit` is an optional function that enables incremental builds. It receives information about which files have changed (`changeEvents`) and can selectively rebuild only the necessary files. This is useful for optimizing build times in development mode. If `partialEmit` is undefined, it will default to the `emit` function.
|
||||||
|
- `getQuartzComponents` declares which Quartz components the emitter uses to construct its pages.
|
||||||
|
|
||||||
Creating new files can be done via regular Node [fs module](https://nodejs.org/api/fs.html) (i.e. `fs.cp` or `fs.writeFile`) or via the `write` function in `quartz/plugins/emitters/helpers.ts` if you are creating files that contain text. `write` has the following signature:
|
Creating new files can be done via regular Node [fs module](https://nodejs.org/api/fs.html) (i.e. `fs.cp` or `fs.writeFile`) or via the `write` function in `quartz/plugins/emitters/helpers.ts` if you are creating files that contain text. `write` has the following signature:
|
||||||
|
|
||||||
@@ -234,7 +249,7 @@ export type WriteOptions = (data: {
|
|||||||
// the build context
|
// the build context
|
||||||
ctx: BuildCtx
|
ctx: BuildCtx
|
||||||
// the name of the file to emit (not including the file extension)
|
// the name of the file to emit (not including the file extension)
|
||||||
slug: ServerSlug
|
slug: FullSlug
|
||||||
// the file extension
|
// the file extension
|
||||||
ext: `.${string}` | ""
|
ext: `.${string}` | ""
|
||||||
// the file content to add
|
// the file content to add
|
||||||
|
|||||||
@@ -108,3 +108,25 @@ Some plugins are included by default in the [`quartz.config.ts`](https://github.
|
|||||||
You can see a list of all plugins and their configuration options [[tags/plugin|here]].
|
You can see a list of all plugins and their configuration options [[tags/plugin|here]].
|
||||||
|
|
||||||
If you'd like to make your own plugins, see the [[making plugins|making custom plugins]] guide.
|
If you'd like to make your own plugins, see the [[making plugins|making custom plugins]] guide.
|
||||||
|
|
||||||
|
## Fonts
|
||||||
|
|
||||||
|
Fonts can be specified as a `string` or a `FontSpecification`:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// string
|
||||||
|
typography: {
|
||||||
|
header: "Schibsted Grotesk",
|
||||||
|
...
|
||||||
|
}
|
||||||
|
|
||||||
|
// FontSpecification
|
||||||
|
typography: {
|
||||||
|
header: {
|
||||||
|
name: "Schibsted Grotesk",
|
||||||
|
weights: [400, 700],
|
||||||
|
includeItalic: true,
|
||||||
|
},
|
||||||
|
...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
@@ -2,400 +2,18 @@
|
|||||||
title: "Social Media Preview Cards"
|
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]].
|
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. To get started with this, set `generateSocialImages: true` in `quartz.config.ts`.
|
|
||||||
|
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
|
## 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 |
|
| Light | Dark |
|
||||||
| ----------------------------------- | ---------------------------------- |
|
| ----------------------------------- | ---------------------------------- |
|
||||||
| ![[social-image-preview-light.png]] | ![[social-image-preview-dark.png]] |
|
| ![[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
|
This functionality is provided by the [[CustomOgImages]] plugin. See the plugin page for customization options.
|
||||||
|
|
||||||
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].<colorName>`, where `<colorName>` corresponds to a key in `ColorScheme` (defined at the top of `quartz/util/theme.ts`)
|
|
||||||
>
|
|
||||||
> - Use the page title/description
|
|
||||||
>
|
|
||||||
> `<p>{title}</p>`/`<p>{description}</p>`
|
|
||||||
>
|
|
||||||
> - 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 <p style={{ fontFamily: fonts[0].name }}>Cool Header!</p>
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> [!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<SatoriOptions["fonts"]> {
|
|
||||||
> 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 (
|
|
||||||
<div
|
|
||||||
style={{
|
|
||||||
display: "flex",
|
|
||||||
flexDirection: "row",
|
|
||||||
justifyContent: "flex-start",
|
|
||||||
alignItems: "center",
|
|
||||||
height: "100%",
|
|
||||||
width: "100%",
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<div
|
|
||||||
style={{
|
|
||||||
display: "flex",
|
|
||||||
alignItems: "center",
|
|
||||||
justifyContent: "center",
|
|
||||||
height: "100%",
|
|
||||||
width: "100%",
|
|
||||||
backgroundColor: cfg.theme.colors[colorScheme].light,
|
|
||||||
flexDirection: "column",
|
|
||||||
gap: "2.5rem",
|
|
||||||
paddingTop: "2rem",
|
|
||||||
paddingBottom: "2rem",
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<p
|
|
||||||
style={{
|
|
||||||
color: cfg.theme.colors[colorScheme].dark,
|
|
||||||
fontSize: useSmallerFont ? 70 : 82,
|
|
||||||
marginLeft: "4rem",
|
|
||||||
textAlign: "center",
|
|
||||||
marginRight: "4rem",
|
|
||||||
fontFamily: fonts[0].name,
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{title}
|
|
||||||
</p>
|
|
||||||
<p
|
|
||||||
style={{
|
|
||||||
color: cfg.theme.colors[colorScheme].dark,
|
|
||||||
fontSize: 44,
|
|
||||||
marginLeft: "8rem",
|
|
||||||
marginRight: "8rem",
|
|
||||||
lineClamp: 3,
|
|
||||||
fontFamily: fonts[1].name,
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{description}
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
<div
|
|
||||||
style={{
|
|
||||||
height: "100%",
|
|
||||||
width: "2vw",
|
|
||||||
position: "absolute",
|
|
||||||
backgroundColor: cfg.theme.colors[colorScheme].tertiary,
|
|
||||||
opacity: 0.85,
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> [!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 (
|
|
||||||
> <div
|
|
||||||
> 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%",
|
|
||||||
> }}
|
|
||||||
> >
|
|
||||||
> <div
|
|
||||||
> 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%)",
|
|
||||||
> }}
|
|
||||||
> />
|
|
||||||
> <div
|
|
||||||
> style={{
|
|
||||||
> display: "flex",
|
|
||||||
> height: "100%",
|
|
||||||
> width: "100%",
|
|
||||||
> flexDirection: "column",
|
|
||||||
> justifyContent: "flex-start",
|
|
||||||
> alignItems: "flex-start",
|
|
||||||
> gap: "1.5rem",
|
|
||||||
> paddingTop: "4rem",
|
|
||||||
> paddingBottom: "4rem",
|
|
||||||
> marginLeft: "4rem",
|
|
||||||
> }}
|
|
||||||
> >
|
|
||||||
> <img
|
|
||||||
> src={`"https://${cfg.baseUrl}/static/icon.jpeg"`}
|
|
||||||
> style={{
|
|
||||||
> position: "relative",
|
|
||||||
> backgroundClip: "border-box",
|
|
||||||
> borderRadius: "6rem",
|
|
||||||
> }}
|
|
||||||
> width={80}
|
|
||||||
> />
|
|
||||||
> <div
|
|
||||||
> style={{
|
|
||||||
> display: "flex",
|
|
||||||
> flexDirection: "column",
|
|
||||||
> textAlign: "left",
|
|
||||||
> fontFamily: fonts[0].name,
|
|
||||||
> }}
|
|
||||||
> >
|
|
||||||
> <h2
|
|
||||||
> style={{
|
|
||||||
> color: cfg.theme.colors[colorScheme].light,
|
|
||||||
> fontSize: "3rem",
|
|
||||||
> fontWeight: 700,
|
|
||||||
> marginRight: "4rem",
|
|
||||||
> fontFamily: fonts[0].name,
|
|
||||||
> }}
|
|
||||||
> >
|
|
||||||
> {title}
|
|
||||||
> </h2>
|
|
||||||
> <ul
|
|
||||||
> style={{
|
|
||||||
> color: cfg.theme.colors[colorScheme].gray,
|
|
||||||
> gap: "1rem",
|
|
||||||
> fontSize: "1.5rem",
|
|
||||||
> fontFamily: fonts[1].name,
|
|
||||||
> }}
|
|
||||||
> >
|
|
||||||
> {Li.map((item, index) => {
|
|
||||||
> if (item) {
|
|
||||||
> return <li key={index}>{item}</li>
|
|
||||||
> }
|
|
||||||
> })}
|
|
||||||
> </ul>
|
|
||||||
> </div>
|
|
||||||
> <p
|
|
||||||
> 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}
|
|
||||||
> </p>
|
|
||||||
> </div>
|
|
||||||
> </div>
|
|
||||||
> )
|
|
||||||
> }
|
|
||||||
> ```
|
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ If you prefer instructions in a video format you can try following Nicole van de
|
|||||||
## 🔧 Features
|
## 🔧 Features
|
||||||
|
|
||||||
- [[Obsidian compatibility]], [[full-text search]], [[graph view]], note transclusion, [[wikilinks]], [[backlinks]], [[features/Latex|Latex]], [[syntax highlighting]], [[popover previews]], [[Docker Support]], [[i18n|internationalization]], [[comments]] and [many more](./features/) right out of the box
|
- [[Obsidian compatibility]], [[full-text search]], [[graph view]], note transclusion, [[wikilinks]], [[backlinks]], [[features/Latex|Latex]], [[syntax highlighting]], [[popover previews]], [[Docker Support]], [[i18n|internationalization]], [[comments]] and [many more](./features/) right out of the box
|
||||||
- Hot-reload for both configuration and content
|
- Hot-reload on configuration edits and incremental rebuilds for content edits
|
||||||
- Simple JSX layouts and [[creating components|page components]]
|
- Simple JSX layouts and [[creating components|page components]]
|
||||||
- [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes
|
- [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes
|
||||||
- Fully-customizable parsing, filtering, and page generation through [[making plugins|plugins]]
|
- Fully-customizable parsing, filtering, and page generation through [[making plugins|plugins]]
|
||||||
|
|||||||
360
docs/plugins/CustomOgImages.md
Normal file
360
docs/plugins/CustomOgImages.md
Normal file
@@ -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 <p style={{ fontFamily: fonts[0].name }}>Cool Header!</p>
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!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 (
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
flexDirection: "row",
|
||||||
|
justifyContent: "flex-start",
|
||||||
|
alignItems: "center",
|
||||||
|
height: "100%",
|
||||||
|
width: "100%",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
alignItems: "center",
|
||||||
|
justifyContent: "center",
|
||||||
|
height: "100%",
|
||||||
|
width: "100%",
|
||||||
|
backgroundColor: cfg.theme.colors[colorScheme].light,
|
||||||
|
flexDirection: "column",
|
||||||
|
gap: "2.5rem",
|
||||||
|
paddingTop: "2rem",
|
||||||
|
paddingBottom: "2rem",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<p
|
||||||
|
style={{
|
||||||
|
color: cfg.theme.colors[colorScheme].dark,
|
||||||
|
fontSize: useSmallerFont ? 70 : 82,
|
||||||
|
marginLeft: "4rem",
|
||||||
|
textAlign: "center",
|
||||||
|
marginRight: "4rem",
|
||||||
|
fontFamily: fonts[0].name,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{title}
|
||||||
|
</p>
|
||||||
|
<p
|
||||||
|
style={{
|
||||||
|
color: cfg.theme.colors[colorScheme].dark,
|
||||||
|
fontSize: 44,
|
||||||
|
marginLeft: "8rem",
|
||||||
|
marginRight: "8rem",
|
||||||
|
lineClamp: 3,
|
||||||
|
fontFamily: fonts[1].name,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{description}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
height: "100%",
|
||||||
|
width: "2vw",
|
||||||
|
position: "absolute",
|
||||||
|
backgroundColor: cfg.theme.colors[colorScheme].tertiary,
|
||||||
|
opacity: 0.85,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 (
|
||||||
|
<div
|
||||||
|
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%",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
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%)",
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
height: "100%",
|
||||||
|
width: "100%",
|
||||||
|
flexDirection: "column",
|
||||||
|
justifyContent: "flex-start",
|
||||||
|
alignItems: "flex-start",
|
||||||
|
gap: "1.5rem",
|
||||||
|
paddingTop: "4rem",
|
||||||
|
paddingBottom: "4rem",
|
||||||
|
marginLeft: "4rem",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<img
|
||||||
|
src={`"https://${cfg.baseUrl}/static/icon.jpeg"`}
|
||||||
|
style={{
|
||||||
|
position: "relative",
|
||||||
|
backgroundClip: "border-box",
|
||||||
|
borderRadius: "6rem",
|
||||||
|
}}
|
||||||
|
width={80}
|
||||||
|
/>
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
flexDirection: "column",
|
||||||
|
textAlign: "left",
|
||||||
|
fontFamily: fonts[0].name,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<h2
|
||||||
|
style={{
|
||||||
|
color: cfg.theme.colors[colorScheme].light,
|
||||||
|
fontSize: "3rem",
|
||||||
|
fontWeight: 700,
|
||||||
|
marginRight: "4rem",
|
||||||
|
fontFamily: fonts[0].name,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{title}
|
||||||
|
</h2>
|
||||||
|
<ul
|
||||||
|
style={{
|
||||||
|
color: cfg.theme.colors[colorScheme].gray,
|
||||||
|
gap: "1rem",
|
||||||
|
fontSize: "1.5rem",
|
||||||
|
fontFamily: fonts[1].name,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{Li.map((item, index) => {
|
||||||
|
if (item) {
|
||||||
|
return <li key={index}>{item}</li>
|
||||||
|
}
|
||||||
|
})}
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<p
|
||||||
|
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}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
32
package-lock.json
generated
32
package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@jackyzha0/quartz",
|
"name": "@jackyzha0/quartz",
|
||||||
"version": "4.4.0",
|
"version": "4.5.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@jackyzha0/quartz",
|
"name": "@jackyzha0/quartz",
|
||||||
"version": "4.4.0",
|
"version": "4.5.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@clack/prompts": "^0.10.0",
|
"@clack/prompts": "^0.10.0",
|
||||||
@@ -14,6 +14,7 @@
|
|||||||
"@myriaddreamin/rehype-typst": "^0.5.4",
|
"@myriaddreamin/rehype-typst": "^0.5.4",
|
||||||
"@napi-rs/simple-git": "0.1.19",
|
"@napi-rs/simple-git": "0.1.19",
|
||||||
"@tweenjs/tween.js": "^25.0.0",
|
"@tweenjs/tween.js": "^25.0.0",
|
||||||
|
"ansi-truncate": "^1.2.0",
|
||||||
"async-mutex": "^0.5.0",
|
"async-mutex": "^0.5.0",
|
||||||
"chalk": "^5.4.1",
|
"chalk": "^5.4.1",
|
||||||
"chokidar": "^4.0.3",
|
"chokidar": "^4.0.3",
|
||||||
@@ -34,6 +35,7 @@
|
|||||||
"mdast-util-to-hast": "^13.2.0",
|
"mdast-util-to-hast": "^13.2.0",
|
||||||
"mdast-util-to-string": "^4.0.0",
|
"mdast-util-to-string": "^4.0.0",
|
||||||
"micromorph": "^0.4.5",
|
"micromorph": "^0.4.5",
|
||||||
|
"minimatch": "^10.0.1",
|
||||||
"pixi.js": "^8.8.1",
|
"pixi.js": "^8.8.1",
|
||||||
"preact": "^10.26.4",
|
"preact": "^10.26.4",
|
||||||
"preact-render-to-string": "^6.5.13",
|
"preact-render-to-string": "^6.5.13",
|
||||||
@@ -75,7 +77,6 @@
|
|||||||
"quartz": "quartz/bootstrap-cli.mjs"
|
"quartz": "quartz/bootstrap-cli.mjs"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/cli-spinner": "^0.2.3",
|
|
||||||
"@types/d3": "^7.4.3",
|
"@types/d3": "^7.4.3",
|
||||||
"@types/hast": "^3.0.4",
|
"@types/hast": "^3.0.4",
|
||||||
"@types/js-yaml": "^4.0.9",
|
"@types/js-yaml": "^4.0.9",
|
||||||
@@ -1585,15 +1586,6 @@
|
|||||||
"integrity": "sha512-XKLA6syeBUaPzx4j3qwMqzzq+V4uo72BnlbOjmuljLrRqdsd3qnzvZZoxvMHZ23ndsRS4aufU6JOZYpCbU6T1A==",
|
"integrity": "sha512-XKLA6syeBUaPzx4j3qwMqzzq+V4uo72BnlbOjmuljLrRqdsd3qnzvZZoxvMHZ23ndsRS4aufU6JOZYpCbU6T1A==",
|
||||||
"license": "MIT"
|
"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": {
|
"node_modules/@types/css-font-loading-module": {
|
||||||
"version": "0.0.12",
|
"version": "0.0.12",
|
||||||
"resolved": "https://registry.npmjs.org/@types/css-font-loading-module/-/css-font-loading-module-0.0.12.tgz",
|
"resolved": "https://registry.npmjs.org/@types/css-font-loading-module/-/css-font-loading-module-0.0.12.tgz",
|
||||||
@@ -2042,6 +2034,15 @@
|
|||||||
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
|
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/ansi-truncate": {
|
||||||
|
"version": "1.2.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-truncate/-/ansi-truncate-1.2.0.tgz",
|
||||||
|
"integrity": "sha512-/SLVrxNIP8o8iRHjdK3K9s2hDqdvb86NEjZOAB6ecWFsOo+9obaby97prnvAPn6j7ExXCpbvtlJFYPkkspg4BQ==",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"fast-string-truncated-width": "^1.2.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/argparse": {
|
"node_modules/argparse": {
|
||||||
"version": "2.0.1",
|
"version": "2.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
|
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
|
||||||
@@ -3068,6 +3069,12 @@
|
|||||||
"node": ">=8.6.0"
|
"node": ">=8.6.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/fast-string-truncated-width": {
|
||||||
|
"version": "1.2.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/fast-string-truncated-width/-/fast-string-truncated-width-1.2.1.tgz",
|
||||||
|
"integrity": "sha512-Q9acT/+Uu3GwGj+5w/zsGuQjh9O1TyywhIwAxHudtWrgF09nHOPrvTLhQevPbttcxjr/SNN7mJmfOw/B1bXgow==",
|
||||||
|
"license": "MIT"
|
||||||
|
},
|
||||||
"node_modules/fastq": {
|
"node_modules/fastq": {
|
||||||
"version": "1.19.0",
|
"version": "1.19.0",
|
||||||
"resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.0.tgz",
|
"resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.0.tgz",
|
||||||
@@ -5248,6 +5255,7 @@
|
|||||||
"version": "10.0.1",
|
"version": "10.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.1.tgz",
|
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.1.tgz",
|
||||||
"integrity": "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==",
|
"integrity": "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==",
|
||||||
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"brace-expansion": "^2.0.1"
|
"brace-expansion": "^2.0.1"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"name": "@jackyzha0/quartz",
|
"name": "@jackyzha0/quartz",
|
||||||
"description": "🌱 publish your digital garden and notes as a website",
|
"description": "🌱 publish your digital garden and notes as a website",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "4.4.0",
|
"version": "4.5.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"author": "jackyzha0 <j.zhao2k19@gmail.com>",
|
"author": "jackyzha0 <j.zhao2k19@gmail.com>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
@@ -40,6 +40,7 @@
|
|||||||
"@myriaddreamin/rehype-typst": "^0.5.4",
|
"@myriaddreamin/rehype-typst": "^0.5.4",
|
||||||
"@napi-rs/simple-git": "0.1.19",
|
"@napi-rs/simple-git": "0.1.19",
|
||||||
"@tweenjs/tween.js": "^25.0.0",
|
"@tweenjs/tween.js": "^25.0.0",
|
||||||
|
"ansi-truncate": "^1.2.0",
|
||||||
"async-mutex": "^0.5.0",
|
"async-mutex": "^0.5.0",
|
||||||
"chalk": "^5.4.1",
|
"chalk": "^5.4.1",
|
||||||
"chokidar": "^4.0.3",
|
"chokidar": "^4.0.3",
|
||||||
@@ -60,6 +61,7 @@
|
|||||||
"mdast-util-to-hast": "^13.2.0",
|
"mdast-util-to-hast": "^13.2.0",
|
||||||
"mdast-util-to-string": "^4.0.0",
|
"mdast-util-to-string": "^4.0.0",
|
||||||
"micromorph": "^0.4.5",
|
"micromorph": "^0.4.5",
|
||||||
|
"minimatch": "^10.0.1",
|
||||||
"pixi.js": "^8.8.1",
|
"pixi.js": "^8.8.1",
|
||||||
"preact": "^10.26.4",
|
"preact": "^10.26.4",
|
||||||
"preact-render-to-string": "^6.5.13",
|
"preact-render-to-string": "^6.5.13",
|
||||||
@@ -98,7 +100,6 @@
|
|||||||
"yargs": "^17.7.2"
|
"yargs": "^17.7.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/cli-spinner": "^0.2.3",
|
|
||||||
"@types/d3": "^7.4.3",
|
"@types/d3": "^7.4.3",
|
||||||
"@types/hast": "^3.0.4",
|
"@types/hast": "^3.0.4",
|
||||||
"@types/js-yaml": "^4.0.9",
|
"@types/js-yaml": "^4.0.9",
|
||||||
|
|||||||
@@ -19,7 +19,6 @@ const config: QuartzConfig = {
|
|||||||
baseUrl: "quartz.jzhao.xyz",
|
baseUrl: "quartz.jzhao.xyz",
|
||||||
ignorePatterns: ["private", "templates", ".obsidian"],
|
ignorePatterns: ["private", "templates", ".obsidian"],
|
||||||
defaultDateType: "created",
|
defaultDateType: "created",
|
||||||
generateSocialImages: true,
|
|
||||||
theme: {
|
theme: {
|
||||||
fontOrigin: "googleFonts",
|
fontOrigin: "googleFonts",
|
||||||
cdnCaching: true,
|
cdnCaching: true,
|
||||||
@@ -58,7 +57,7 @@ const config: QuartzConfig = {
|
|||||||
transformers: [
|
transformers: [
|
||||||
Plugin.FrontMatter(),
|
Plugin.FrontMatter(),
|
||||||
Plugin.CreatedModifiedDate({
|
Plugin.CreatedModifiedDate({
|
||||||
priority: ["frontmatter", "filesystem"],
|
priority: ["git", "frontmatter", "filesystem"],
|
||||||
}),
|
}),
|
||||||
Plugin.SyntaxHighlighting({
|
Plugin.SyntaxHighlighting({
|
||||||
theme: {
|
theme: {
|
||||||
@@ -88,6 +87,8 @@ const config: QuartzConfig = {
|
|||||||
Plugin.Assets(),
|
Plugin.Assets(),
|
||||||
Plugin.Static(),
|
Plugin.Static(),
|
||||||
Plugin.NotFoundPage(),
|
Plugin.NotFoundPage(),
|
||||||
|
// Comment out CustomOgImages to speed up build time
|
||||||
|
Plugin.CustomOgImages(),
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,8 +49,15 @@ export const defaultListPageLayout: PageLayout = {
|
|||||||
left: [
|
left: [
|
||||||
Component.PageTitle(),
|
Component.PageTitle(),
|
||||||
Component.MobileOnly(Component.Spacer()),
|
Component.MobileOnly(Component.Spacer()),
|
||||||
Component.Search(),
|
Component.Flex({
|
||||||
Component.Darkmode(),
|
components: [
|
||||||
|
{
|
||||||
|
Component: Component.Search(),
|
||||||
|
grow: true,
|
||||||
|
},
|
||||||
|
{ Component: Component.Darkmode() },
|
||||||
|
],
|
||||||
|
}),
|
||||||
Component.Explorer(),
|
Component.Explorer(),
|
||||||
],
|
],
|
||||||
right: [],
|
right: [],
|
||||||
|
|||||||
423
quartz/build.ts
423
quartz/build.ts
@@ -9,7 +9,7 @@ import { parseMarkdown } from "./processors/parse"
|
|||||||
import { filterContent } from "./processors/filter"
|
import { filterContent } from "./processors/filter"
|
||||||
import { emitContent } from "./processors/emit"
|
import { emitContent } from "./processors/emit"
|
||||||
import cfg from "../quartz.config"
|
import cfg from "../quartz.config"
|
||||||
import { FilePath, FullSlug, joinSegments, slugifyFilePath } from "./util/path"
|
import { FilePath, joinSegments, slugifyFilePath } from "./util/path"
|
||||||
import chokidar from "chokidar"
|
import chokidar from "chokidar"
|
||||||
import { ProcessedContent } from "./plugins/vfile"
|
import { ProcessedContent } from "./plugins/vfile"
|
||||||
import { Argv, BuildCtx } from "./util/ctx"
|
import { Argv, BuildCtx } from "./util/ctx"
|
||||||
@@ -17,34 +17,39 @@ import { glob, toPosixPath } from "./util/glob"
|
|||||||
import { trace } from "./util/trace"
|
import { trace } from "./util/trace"
|
||||||
import { options } from "./util/sourcemap"
|
import { options } from "./util/sourcemap"
|
||||||
import { Mutex } from "async-mutex"
|
import { Mutex } from "async-mutex"
|
||||||
import DepGraph from "./depgraph"
|
|
||||||
import { getStaticResourcesFromPlugins } from "./plugins"
|
import { getStaticResourcesFromPlugins } from "./plugins"
|
||||||
import { randomIdNonSecure } from "./util/random"
|
import { randomIdNonSecure } from "./util/random"
|
||||||
|
import { ChangeEvent } from "./plugins/types"
|
||||||
|
import { minimatch } from "minimatch"
|
||||||
|
|
||||||
type Dependencies = Record<string, DepGraph<FilePath> | null>
|
type ContentMap = Map<
|
||||||
|
FilePath,
|
||||||
|
| {
|
||||||
|
type: "markdown"
|
||||||
|
content: ProcessedContent
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
type: "other"
|
||||||
|
}
|
||||||
|
>
|
||||||
|
|
||||||
type BuildData = {
|
type BuildData = {
|
||||||
ctx: BuildCtx
|
ctx: BuildCtx
|
||||||
ignored: GlobbyFilterFunction
|
ignored: GlobbyFilterFunction
|
||||||
mut: Mutex
|
mut: Mutex
|
||||||
initialSlugs: FullSlug[]
|
contentMap: ContentMap
|
||||||
// TODO merge contentMap and trackedAssets
|
changesSinceLastBuild: Record<FilePath, ChangeEvent["type"]>
|
||||||
contentMap: Map<FilePath, ProcessedContent>
|
|
||||||
trackedAssets: Set<FilePath>
|
|
||||||
toRebuild: Set<FilePath>
|
|
||||||
toRemove: Set<FilePath>
|
|
||||||
lastBuildMs: number
|
lastBuildMs: number
|
||||||
dependencies: Dependencies
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type FileEvent = "add" | "change" | "delete"
|
|
||||||
|
|
||||||
async function buildQuartz(argv: Argv, mut: Mutex, clientRefresh: () => void) {
|
async function buildQuartz(argv: Argv, mut: Mutex, clientRefresh: () => void) {
|
||||||
const ctx: BuildCtx = {
|
const ctx: BuildCtx = {
|
||||||
buildId: randomIdNonSecure(),
|
buildId: randomIdNonSecure(),
|
||||||
argv,
|
argv,
|
||||||
cfg,
|
cfg,
|
||||||
allSlugs: [],
|
allSlugs: [],
|
||||||
|
allFiles: [],
|
||||||
|
incremental: false,
|
||||||
}
|
}
|
||||||
|
|
||||||
const perf = new PerfTimer()
|
const perf = new PerfTimer()
|
||||||
@@ -67,64 +72,70 @@ async function buildQuartz(argv: Argv, mut: Mutex, clientRefresh: () => void) {
|
|||||||
|
|
||||||
perf.addEvent("glob")
|
perf.addEvent("glob")
|
||||||
const allFiles = await glob("**/*.*", argv.directory, cfg.configuration.ignorePatterns)
|
const allFiles = await glob("**/*.*", argv.directory, cfg.configuration.ignorePatterns)
|
||||||
const fps = allFiles.filter((fp) => fp.endsWith(".md")).sort()
|
const markdownPaths = allFiles.filter((fp) => fp.endsWith(".md")).sort()
|
||||||
console.log(
|
console.log(
|
||||||
`Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`,
|
`Found ${markdownPaths.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`,
|
||||||
)
|
)
|
||||||
|
|
||||||
const filePaths = fps.map((fp) => joinSegments(argv.directory, fp) as FilePath)
|
const filePaths = markdownPaths.map((fp) => joinSegments(argv.directory, fp) as FilePath)
|
||||||
|
ctx.allFiles = allFiles
|
||||||
ctx.allSlugs = allFiles.map((fp) => slugifyFilePath(fp as FilePath))
|
ctx.allSlugs = allFiles.map((fp) => slugifyFilePath(fp as FilePath))
|
||||||
|
|
||||||
const parsedFiles = await parseMarkdown(ctx, filePaths)
|
const parsedFiles = await parseMarkdown(ctx, filePaths)
|
||||||
const filteredContent = filterContent(ctx, parsedFiles)
|
const filteredContent = filterContent(ctx, parsedFiles)
|
||||||
|
|
||||||
const dependencies: Record<string, DepGraph<FilePath> | null> = {}
|
|
||||||
|
|
||||||
// Only build dependency graphs if we're doing a fast rebuild
|
|
||||||
if (argv.fastRebuild) {
|
|
||||||
const staticResources = getStaticResourcesFromPlugins(ctx)
|
|
||||||
for (const emitter of cfg.plugins.emitters) {
|
|
||||||
dependencies[emitter.name] =
|
|
||||||
(await emitter.getDependencyGraph?.(ctx, filteredContent, staticResources)) ?? null
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
await emitContent(ctx, filteredContent)
|
await emitContent(ctx, filteredContent)
|
||||||
console.log(chalk.green(`Done processing ${fps.length} files in ${perf.timeSince()}`))
|
console.log(chalk.green(`Done processing ${markdownPaths.length} files in ${perf.timeSince()}`))
|
||||||
release()
|
release()
|
||||||
|
|
||||||
if (argv.serve) {
|
if (argv.watch) {
|
||||||
return startServing(ctx, mut, parsedFiles, clientRefresh, dependencies)
|
ctx.incremental = true
|
||||||
|
return startWatching(ctx, mut, parsedFiles, clientRefresh)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// setup watcher for rebuilds
|
// setup watcher for rebuilds
|
||||||
async function startServing(
|
async function startWatching(
|
||||||
ctx: BuildCtx,
|
ctx: BuildCtx,
|
||||||
mut: Mutex,
|
mut: Mutex,
|
||||||
initialContent: ProcessedContent[],
|
initialContent: ProcessedContent[],
|
||||||
clientRefresh: () => void,
|
clientRefresh: () => void,
|
||||||
dependencies: Dependencies, // emitter name: dep graph
|
|
||||||
) {
|
) {
|
||||||
const { argv } = ctx
|
const { argv, allFiles } = ctx
|
||||||
|
|
||||||
// cache file parse results
|
const contentMap: ContentMap = new Map()
|
||||||
const contentMap = new Map<FilePath, ProcessedContent>()
|
for (const filePath of allFiles) {
|
||||||
for (const content of initialContent) {
|
contentMap.set(filePath, {
|
||||||
const [_tree, vfile] = content
|
type: "other",
|
||||||
contentMap.set(vfile.data.filePath!, content)
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
for (const content of initialContent) {
|
||||||
|
const [_tree, vfile] = content
|
||||||
|
contentMap.set(vfile.data.relativePath!, {
|
||||||
|
type: "markdown",
|
||||||
|
content,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const gitIgnoredMatcher = await isGitIgnored()
|
||||||
const buildData: BuildData = {
|
const buildData: BuildData = {
|
||||||
ctx,
|
ctx,
|
||||||
mut,
|
mut,
|
||||||
dependencies,
|
|
||||||
contentMap,
|
contentMap,
|
||||||
ignored: await isGitIgnored(),
|
ignored: (path) => {
|
||||||
initialSlugs: ctx.allSlugs,
|
if (gitIgnoredMatcher(path)) return true
|
||||||
toRebuild: new Set<FilePath>(),
|
const pathStr = path.toString()
|
||||||
toRemove: new Set<FilePath>(),
|
for (const pattern of cfg.configuration.ignorePatterns) {
|
||||||
trackedAssets: new Set<FilePath>(),
|
if (minimatch(pathStr, pattern)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
},
|
||||||
|
|
||||||
|
changesSinceLastBuild: {},
|
||||||
lastBuildMs: 0,
|
lastBuildMs: 0,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -134,34 +145,37 @@ async function startServing(
|
|||||||
ignoreInitial: true,
|
ignoreInitial: true,
|
||||||
})
|
})
|
||||||
|
|
||||||
const buildFromEntry = argv.fastRebuild ? partialRebuildFromEntrypoint : rebuildFromEntrypoint
|
const changes: ChangeEvent[] = []
|
||||||
watcher
|
watcher
|
||||||
.on("add", (fp) => buildFromEntry(fp as string, "add", clientRefresh, buildData))
|
.on("add", (fp) => {
|
||||||
.on("change", (fp) => buildFromEntry(fp as string, "change", clientRefresh, buildData))
|
if (buildData.ignored(fp)) return
|
||||||
.on("unlink", (fp) => buildFromEntry(fp as string, "delete", clientRefresh, buildData))
|
changes.push({ path: fp as FilePath, type: "add" })
|
||||||
|
void rebuild(changes, clientRefresh, buildData)
|
||||||
|
})
|
||||||
|
.on("change", (fp) => {
|
||||||
|
if (buildData.ignored(fp)) return
|
||||||
|
changes.push({ path: fp as FilePath, type: "change" })
|
||||||
|
void rebuild(changes, clientRefresh, buildData)
|
||||||
|
})
|
||||||
|
.on("unlink", (fp) => {
|
||||||
|
if (buildData.ignored(fp)) return
|
||||||
|
changes.push({ path: fp as FilePath, type: "delete" })
|
||||||
|
void rebuild(changes, clientRefresh, buildData)
|
||||||
|
})
|
||||||
|
|
||||||
return async () => {
|
return async () => {
|
||||||
await watcher.close()
|
await watcher.close()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function partialRebuildFromEntrypoint(
|
async function rebuild(changes: ChangeEvent[], clientRefresh: () => void, buildData: BuildData) {
|
||||||
filepath: string,
|
const { ctx, contentMap, mut, changesSinceLastBuild } = buildData
|
||||||
action: FileEvent,
|
|
||||||
clientRefresh: () => void,
|
|
||||||
buildData: BuildData, // note: this function mutates buildData
|
|
||||||
) {
|
|
||||||
const { ctx, ignored, dependencies, contentMap, mut, toRemove } = buildData
|
|
||||||
const { argv, cfg } = ctx
|
const { argv, cfg } = ctx
|
||||||
|
|
||||||
// don't do anything for gitignored files
|
|
||||||
if (ignored(filepath)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
const buildId = randomIdNonSecure()
|
const buildId = randomIdNonSecure()
|
||||||
ctx.buildId = buildId
|
ctx.buildId = buildId
|
||||||
buildData.lastBuildMs = new Date().getTime()
|
buildData.lastBuildMs = new Date().getTime()
|
||||||
|
const numChangesInBuild = changes.length
|
||||||
const release = await mut.acquire()
|
const release = await mut.acquire()
|
||||||
|
|
||||||
// if there's another build after us, release and let them do it
|
// if there's another build after us, release and let them do it
|
||||||
@@ -171,242 +185,105 @@ async function partialRebuildFromEntrypoint(
|
|||||||
}
|
}
|
||||||
|
|
||||||
const perf = new PerfTimer()
|
const perf = new PerfTimer()
|
||||||
|
perf.addEvent("rebuild")
|
||||||
console.log(chalk.yellow("Detected change, rebuilding..."))
|
console.log(chalk.yellow("Detected change, rebuilding..."))
|
||||||
|
|
||||||
// UPDATE DEP GRAPH
|
// update changesSinceLastBuild
|
||||||
const fp = joinSegments(argv.directory, toPosixPath(filepath)) as FilePath
|
for (const change of changes) {
|
||||||
|
changesSinceLastBuild[change.path] = change.type
|
||||||
|
}
|
||||||
|
|
||||||
const staticResources = getStaticResourcesFromPlugins(ctx)
|
const staticResources = getStaticResourcesFromPlugins(ctx)
|
||||||
let processedFiles: ProcessedContent[] = []
|
const pathsToParse: FilePath[] = []
|
||||||
|
for (const [fp, type] of Object.entries(changesSinceLastBuild)) {
|
||||||
switch (action) {
|
if (type === "delete" || path.extname(fp) !== ".md") continue
|
||||||
case "add":
|
const fullPath = joinSegments(argv.directory, toPosixPath(fp)) as FilePath
|
||||||
// add to cache when new file is added
|
pathsToParse.push(fullPath)
|
||||||
processedFiles = await parseMarkdown(ctx, [fp])
|
|
||||||
processedFiles.forEach(([tree, vfile]) => contentMap.set(vfile.data.filePath!, [tree, vfile]))
|
|
||||||
|
|
||||||
// update the dep graph by asking all emitters whether they depend on this file
|
|
||||||
for (const emitter of cfg.plugins.emitters) {
|
|
||||||
const emitterGraph =
|
|
||||||
(await emitter.getDependencyGraph?.(ctx, processedFiles, staticResources)) ?? null
|
|
||||||
|
|
||||||
if (emitterGraph) {
|
|
||||||
const existingGraph = dependencies[emitter.name]
|
|
||||||
if (existingGraph !== null) {
|
|
||||||
existingGraph.mergeGraph(emitterGraph)
|
|
||||||
} else {
|
|
||||||
// might be the first time we're adding a mardown file
|
|
||||||
dependencies[emitter.name] = emitterGraph
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break
|
|
||||||
case "change":
|
|
||||||
// invalidate cache when file is changed
|
|
||||||
processedFiles = await parseMarkdown(ctx, [fp])
|
|
||||||
processedFiles.forEach(([tree, vfile]) => contentMap.set(vfile.data.filePath!, [tree, vfile]))
|
|
||||||
|
|
||||||
// only content files can have added/removed dependencies because of transclusions
|
|
||||||
if (path.extname(fp) === ".md") {
|
|
||||||
for (const emitter of cfg.plugins.emitters) {
|
|
||||||
// get new dependencies from all emitters for this file
|
|
||||||
const emitterGraph =
|
|
||||||
(await emitter.getDependencyGraph?.(ctx, processedFiles, staticResources)) ?? null
|
|
||||||
|
|
||||||
// only update the graph if the emitter plugin uses the changed file
|
|
||||||
// eg. Assets plugin ignores md files, so we skip updating the graph
|
|
||||||
if (emitterGraph?.hasNode(fp)) {
|
|
||||||
// merge the new dependencies into the dep graph
|
|
||||||
dependencies[emitter.name]?.updateIncomingEdgesForNode(emitterGraph, fp)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break
|
|
||||||
case "delete":
|
|
||||||
toRemove.add(fp)
|
|
||||||
break
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (argv.verbose) {
|
const parsed = await parseMarkdown(ctx, pathsToParse)
|
||||||
console.log(`Updated dependency graphs in ${perf.timeSince()}`)
|
for (const content of parsed) {
|
||||||
|
contentMap.set(content[1].data.relativePath!, {
|
||||||
|
type: "markdown",
|
||||||
|
content,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
// EMIT
|
// update state using changesSinceLastBuild
|
||||||
perf.addEvent("rebuild")
|
// we do this weird play of add => compute change events => remove
|
||||||
|
// so that partialEmitters can do appropriate cleanup based on the content of deleted files
|
||||||
|
for (const [file, change] of Object.entries(changesSinceLastBuild)) {
|
||||||
|
if (change === "delete") {
|
||||||
|
// universal delete case
|
||||||
|
contentMap.delete(file as FilePath)
|
||||||
|
}
|
||||||
|
|
||||||
|
// manually track non-markdown files as processed files only
|
||||||
|
// contains markdown files
|
||||||
|
if (change === "add" && path.extname(file) !== ".md") {
|
||||||
|
contentMap.set(file as FilePath, {
|
||||||
|
type: "other",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const changeEvents: ChangeEvent[] = Object.entries(changesSinceLastBuild).map(([fp, type]) => {
|
||||||
|
const path = fp as FilePath
|
||||||
|
const processedContent = contentMap.get(path)
|
||||||
|
if (processedContent?.type === "markdown") {
|
||||||
|
const [_tree, file] = processedContent.content
|
||||||
|
return {
|
||||||
|
type,
|
||||||
|
path,
|
||||||
|
file,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
type,
|
||||||
|
path,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// update allFiles and then allSlugs with the consistent view of content map
|
||||||
|
ctx.allFiles = Array.from(contentMap.keys())
|
||||||
|
ctx.allSlugs = ctx.allFiles.map((fp) => slugifyFilePath(fp as FilePath))
|
||||||
|
const processedFiles = Array.from(contentMap.values())
|
||||||
|
.filter((file) => file.type === "markdown")
|
||||||
|
.map((file) => file.content)
|
||||||
|
|
||||||
let emittedFiles = 0
|
let emittedFiles = 0
|
||||||
|
|
||||||
for (const emitter of cfg.plugins.emitters) {
|
for (const emitter of cfg.plugins.emitters) {
|
||||||
const depGraph = dependencies[emitter.name]
|
// Try to use partialEmit if available, otherwise assume the output is static
|
||||||
|
const emitFn = emitter.partialEmit ?? emitter.emit
|
||||||
// emitter hasn't defined a dependency graph. call it with all processed files
|
const emitted = await emitFn(ctx, processedFiles, staticResources, changeEvents)
|
||||||
if (depGraph === null) {
|
if (emitted === null) {
|
||||||
if (argv.verbose) {
|
|
||||||
console.log(
|
|
||||||
`Emitter ${emitter.name} doesn't define a dependency graph. Calling it with all files...`,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
const files = [...contentMap.values()].filter(
|
|
||||||
([_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}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
emittedFiles += emittedFps.length
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// only call the emitter if it uses this file
|
if (Symbol.asyncIterator in emitted) {
|
||||||
if (depGraph.hasNode(fp)) {
|
// Async generator case
|
||||||
// re-emit using all files that are needed for the downstream of this file
|
for await (const file of emitted) {
|
||||||
// eg. for ContentIndex, the dep graph could be:
|
emittedFiles++
|
||||||
// a.md --> contentIndex.json
|
if (ctx.argv.verbose) {
|
||||||
// b.md ------^
|
console.log(`[emit:${emitter.name}] ${file}`)
|
||||||
//
|
}
|
||||||
// if a.md changes, we need to re-emit contentIndex.json,
|
}
|
||||||
// and supply [a.md, b.md] to the emitter
|
} else {
|
||||||
const upstreams = [...depGraph.getLeafNodeAncestors(fp)] as FilePath[]
|
// Array case
|
||||||
|
emittedFiles += emitted.length
|
||||||
const upstreamContent = upstreams
|
if (ctx.argv.verbose) {
|
||||||
// filter out non-markdown files
|
for (const file of emitted) {
|
||||||
.filter((file) => contentMap.has(file))
|
|
||||||
// if file was deleted, don't give it to the emitter
|
|
||||||
.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}`)
|
console.log(`[emit:${emitter.name}] ${file}`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
emittedFiles += emittedFps.length
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince("rebuild")}`)
|
console.log(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince("rebuild")}`)
|
||||||
|
|
||||||
// CLEANUP
|
|
||||||
const destinationsToDelete = new Set<FilePath>()
|
|
||||||
for (const file of toRemove) {
|
|
||||||
// remove from cache
|
|
||||||
contentMap.delete(file)
|
|
||||||
Object.values(dependencies).forEach((depGraph) => {
|
|
||||||
// remove the node from dependency graphs
|
|
||||||
depGraph?.removeNode(file)
|
|
||||||
// remove any orphan nodes. eg if a.md is deleted, a.html is orphaned and should be removed
|
|
||||||
const orphanNodes = depGraph?.removeOrphanNodes()
|
|
||||||
orphanNodes?.forEach((node) => {
|
|
||||||
// only delete files that are in the output directory
|
|
||||||
if (node.startsWith(argv.output)) {
|
|
||||||
destinationsToDelete.add(node)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
|
||||||
await rimraf([...destinationsToDelete])
|
|
||||||
|
|
||||||
console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
|
console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
|
||||||
|
changes.splice(0, numChangesInBuild)
|
||||||
toRemove.clear()
|
|
||||||
release()
|
|
||||||
clientRefresh()
|
clientRefresh()
|
||||||
}
|
|
||||||
|
|
||||||
async function rebuildFromEntrypoint(
|
|
||||||
fp: string,
|
|
||||||
action: FileEvent,
|
|
||||||
clientRefresh: () => void,
|
|
||||||
buildData: BuildData, // note: this function mutates buildData
|
|
||||||
) {
|
|
||||||
const { ctx, ignored, mut, initialSlugs, contentMap, toRebuild, toRemove, trackedAssets } =
|
|
||||||
buildData
|
|
||||||
|
|
||||||
const { argv } = ctx
|
|
||||||
|
|
||||||
// don't do anything for gitignored files
|
|
||||||
if (ignored(fp)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// dont bother rebuilding for non-content files, just track and refresh
|
|
||||||
fp = toPosixPath(fp)
|
|
||||||
const filePath = joinSegments(argv.directory, fp) as FilePath
|
|
||||||
if (path.extname(fp) !== ".md") {
|
|
||||||
if (action === "add" || action === "change") {
|
|
||||||
trackedAssets.add(filePath)
|
|
||||||
} else if (action === "delete") {
|
|
||||||
trackedAssets.delete(filePath)
|
|
||||||
}
|
|
||||||
clientRefresh()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (action === "add" || action === "change") {
|
|
||||||
toRebuild.add(filePath)
|
|
||||||
} else if (action === "delete") {
|
|
||||||
toRemove.add(filePath)
|
|
||||||
}
|
|
||||||
|
|
||||||
const buildId = randomIdNonSecure()
|
|
||||||
ctx.buildId = buildId
|
|
||||||
buildData.lastBuildMs = new Date().getTime()
|
|
||||||
const release = await mut.acquire()
|
|
||||||
|
|
||||||
// there's another build after us, release and let them do it
|
|
||||||
if (ctx.buildId !== buildId) {
|
|
||||||
release()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
const perf = new PerfTimer()
|
|
||||||
console.log(chalk.yellow("Detected change, rebuilding..."))
|
|
||||||
|
|
||||||
try {
|
|
||||||
const filesToRebuild = [...toRebuild].filter((fp) => !toRemove.has(fp))
|
|
||||||
const parsedContent = await parseMarkdown(ctx, filesToRebuild)
|
|
||||||
for (const content of parsedContent) {
|
|
||||||
const [_tree, vfile] = content
|
|
||||||
contentMap.set(vfile.data.filePath!, content)
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const fp of toRemove) {
|
|
||||||
contentMap.delete(fp)
|
|
||||||
}
|
|
||||||
|
|
||||||
const parsedFiles = [...contentMap.values()]
|
|
||||||
const filteredContent = filterContent(ctx, parsedFiles)
|
|
||||||
|
|
||||||
// re-update slugs
|
|
||||||
const trackedSlugs = [...new Set([...contentMap.keys(), ...toRebuild, ...trackedAssets])]
|
|
||||||
.filter((fp) => !toRemove.has(fp))
|
|
||||||
.map((fp) => slugifyFilePath(path.posix.relative(argv.directory, fp) as FilePath))
|
|
||||||
|
|
||||||
ctx.allSlugs = [...new Set([...initialSlugs, ...trackedSlugs])]
|
|
||||||
|
|
||||||
// TODO: we can probably traverse the link graph to figure out what's safe to delete here
|
|
||||||
// instead of just deleting everything
|
|
||||||
await rimraf(path.join(argv.output, ".*"), { glob: true })
|
|
||||||
await emitContent(ctx, filteredContent)
|
|
||||||
console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
|
|
||||||
} catch (err) {
|
|
||||||
console.log(chalk.yellow(`Rebuild failed. Waiting on a change to fix the error...`))
|
|
||||||
if (argv.verbose) {
|
|
||||||
console.log(chalk.red(err))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
clientRefresh()
|
|
||||||
toRebuild.clear()
|
|
||||||
toRemove.clear()
|
|
||||||
release()
|
release()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ import { ValidDateType } from "./components/Date"
|
|||||||
import { QuartzComponent } from "./components/types"
|
import { QuartzComponent } from "./components/types"
|
||||||
import { ValidLocale } from "./i18n"
|
import { ValidLocale } from "./i18n"
|
||||||
import { PluginTypes } from "./plugins/types"
|
import { PluginTypes } from "./plugins/types"
|
||||||
import { SocialImageOptions } from "./util/og"
|
|
||||||
import { Theme } from "./util/theme"
|
import { Theme } from "./util/theme"
|
||||||
|
|
||||||
export type Analytics =
|
export type Analytics =
|
||||||
@@ -61,10 +60,6 @@ export interface GlobalConfiguration {
|
|||||||
* Quartz will avoid using this as much as possible and use relative URLs most of the time
|
* Quartz will avoid using this as much as possible and use relative URLs most of the time
|
||||||
*/
|
*/
|
||||||
baseUrl?: string
|
baseUrl?: string
|
||||||
/**
|
|
||||||
* Whether to generate social images (Open Graph and Twitter standard) for link previews
|
|
||||||
*/
|
|
||||||
generateSocialImages: boolean | Partial<SocialImageOptions>
|
|
||||||
theme: Theme
|
theme: Theme
|
||||||
/**
|
/**
|
||||||
* Allow to translate the date in the language of your choice.
|
* Allow to translate the date in the language of your choice.
|
||||||
|
|||||||
@@ -71,10 +71,10 @@ export const BuildArgv = {
|
|||||||
default: false,
|
default: false,
|
||||||
describe: "run a local server to live-preview your Quartz",
|
describe: "run a local server to live-preview your Quartz",
|
||||||
},
|
},
|
||||||
fastRebuild: {
|
watch: {
|
||||||
boolean: true,
|
boolean: true,
|
||||||
default: false,
|
default: false,
|
||||||
describe: "[experimental] rebuild only the changed files",
|
describe: "watch for changes and rebuild automatically",
|
||||||
},
|
},
|
||||||
baseDir: {
|
baseDir: {
|
||||||
string: true,
|
string: true,
|
||||||
|
|||||||
@@ -225,6 +225,10 @@ See the [documentation](https://quartz.jzhao.xyz) for how to get started.
|
|||||||
* @param {*} argv arguments for `build`
|
* @param {*} argv arguments for `build`
|
||||||
*/
|
*/
|
||||||
export async function handleBuild(argv) {
|
export async function handleBuild(argv) {
|
||||||
|
if (argv.serve) {
|
||||||
|
argv.watch = true
|
||||||
|
}
|
||||||
|
|
||||||
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
|
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
|
||||||
const ctx = await esbuild.context({
|
const ctx = await esbuild.context({
|
||||||
entryPoints: [fp],
|
entryPoints: [fp],
|
||||||
@@ -331,9 +335,10 @@ export async function handleBuild(argv) {
|
|||||||
clientRefresh()
|
clientRefresh()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
let clientRefresh = () => {}
|
||||||
if (argv.serve) {
|
if (argv.serve) {
|
||||||
const connections = []
|
const connections = []
|
||||||
const clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
|
clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
|
||||||
|
|
||||||
if (argv.baseDir !== "" && !argv.baseDir.startsWith("/")) {
|
if (argv.baseDir !== "" && !argv.baseDir.startsWith("/")) {
|
||||||
argv.baseDir = "/" + argv.baseDir
|
argv.baseDir = "/" + argv.baseDir
|
||||||
@@ -433,6 +438,7 @@ export async function handleBuild(argv) {
|
|||||||
|
|
||||||
return serve()
|
return serve()
|
||||||
})
|
})
|
||||||
|
|
||||||
server.listen(argv.port)
|
server.listen(argv.port)
|
||||||
const wss = new WebSocketServer({ port: argv.wsPort })
|
const wss = new WebSocketServer({ port: argv.wsPort })
|
||||||
wss.on("connection", (ws) => connections.push(ws))
|
wss.on("connection", (ws) => connections.push(ws))
|
||||||
@@ -441,16 +447,27 @@ export async function handleBuild(argv) {
|
|||||||
`Started a Quartz server listening at http://localhost:${argv.port}${argv.baseDir}`,
|
`Started a Quartz server listening at http://localhost:${argv.port}${argv.baseDir}`,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
console.log("hint: exit with ctrl+c")
|
} else {
|
||||||
const paths = await globby(["**/*.ts", "**/*.tsx", "**/*.scss", "package.json"])
|
await build(clientRefresh)
|
||||||
|
ctx.dispose()
|
||||||
|
}
|
||||||
|
|
||||||
|
if (argv.watch) {
|
||||||
|
const paths = await globby([
|
||||||
|
"**/*.ts",
|
||||||
|
"quartz/cli/*.js",
|
||||||
|
"quartz/static/**/*",
|
||||||
|
"**/*.tsx",
|
||||||
|
"**/*.scss",
|
||||||
|
"package.json",
|
||||||
|
])
|
||||||
chokidar
|
chokidar
|
||||||
.watch(paths, { ignoreInitial: true })
|
.watch(paths, { ignoreInitial: true })
|
||||||
.on("add", () => build(clientRefresh))
|
.on("add", () => build(clientRefresh))
|
||||||
.on("change", () => build(clientRefresh))
|
.on("change", () => build(clientRefresh))
|
||||||
.on("unlink", () => build(clientRefresh))
|
.on("unlink", () => build(clientRefresh))
|
||||||
} else {
|
|
||||||
await build(() => {})
|
console.log(chalk.grey("hint: exit with ctrl+c"))
|
||||||
ctx.dispose()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ export default ((opts?: Partial<BreadcrumbOptions>) => {
|
|||||||
|
|
||||||
// Add current slug to full path
|
// Add current slug to full path
|
||||||
currentPath = joinSegments(currentPath, slugParts[i])
|
currentPath = joinSegments(currentPath, slugParts[i])
|
||||||
const includeTrailingSlash = !isTagPath || i < 1
|
const includeTrailingSlash = !isTagPath || i < slugParts.length - 1
|
||||||
|
|
||||||
// Format and add current crumb
|
// Format and add current crumb
|
||||||
const crumb = formatCrumb(
|
const crumb = formatCrumb(
|
||||||
|
|||||||
@@ -1,173 +1,41 @@
|
|||||||
import { i18n } from "../i18n"
|
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 { CSSResourceToStyleElement, JSResourceToScriptElement } from "../util/resources"
|
||||||
import { getFontSpecificationName, googleFontHref } from "../util/theme"
|
import { googleFontHref } from "../util/theme"
|
||||||
import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "./types"
|
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"
|
import { unescapeHTML } from "../util/escape"
|
||||||
|
import { CustomOgImagesEmitterName } from "../plugins/emitters/ogImage"
|
||||||
/**
|
|
||||||
* 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,
|
|
||||||
}
|
|
||||||
|
|
||||||
export default (() => {
|
export default (() => {
|
||||||
let fontsPromise: Promise<SatoriOptions["fonts"]>
|
|
||||||
|
|
||||||
let fullOptions: SocialImageOptions
|
|
||||||
const Head: QuartzComponent = ({
|
const Head: QuartzComponent = ({
|
||||||
cfg,
|
cfg,
|
||||||
fileData,
|
fileData,
|
||||||
externalResources,
|
externalResources,
|
||||||
ctx,
|
ctx,
|
||||||
}: QuartzComponentProps) => {
|
}: 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 titleSuffix = cfg.pageTitleSuffix ?? ""
|
||||||
const title =
|
const title =
|
||||||
(fileData.frontmatter?.title ?? i18n(cfg.locale).propertyDefaults.title) + titleSuffix
|
(fileData.frontmatter?.title ?? i18n(cfg.locale).propertyDefaults.title) + titleSuffix
|
||||||
let description = ""
|
const description =
|
||||||
if (fdDescription) {
|
fileData.frontmatter?.socialDescription ??
|
||||||
description = unescapeHTML(fdDescription)
|
fileData.frontmatter?.description ??
|
||||||
}
|
unescapeHTML(fileData.description?.trim() ?? i18n(cfg.locale).propertyDefaults.description)
|
||||||
|
|
||||||
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 { css, js, additionalHead } = externalResources
|
const { css, js, additionalHead } = externalResources
|
||||||
|
|
||||||
const url = new URL(`https://${cfg.baseUrl ?? "example.com"}`)
|
const url = new URL(`https://${cfg.baseUrl ?? "example.com"}`)
|
||||||
const path = url.pathname as FullSlug
|
const path = url.pathname as FullSlug
|
||||||
const baseDir = fileData.slug === "404" ? path : pathToRoot(fileData.slug!)
|
const baseDir = fileData.slug === "404" ? path : pathToRoot(fileData.slug!)
|
||||||
|
|
||||||
const iconPath = joinSegments(baseDir, "static/icon.png")
|
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
|
// Url of current page
|
||||||
const socialUrl =
|
const socialUrl =
|
||||||
fileData.slug === "404" ? url.toString() : joinSegments(url.toString(), fileData.slug!)
|
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 (
|
return (
|
||||||
<head>
|
<head>
|
||||||
<title>{title}</title>
|
<title>{title}</title>
|
||||||
@@ -181,7 +49,7 @@ export default (() => {
|
|||||||
)}
|
)}
|
||||||
<link rel="preconnect" href="https://cdnjs.cloudflare.com" crossOrigin="anonymous" />
|
<link rel="preconnect" href="https://cdnjs.cloudflare.com" crossOrigin="anonymous" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
{/* OG/Twitter meta tags */}
|
|
||||||
<meta name="og:site_name" content={cfg.pageTitle}></meta>
|
<meta name="og:site_name" content={cfg.pageTitle}></meta>
|
||||||
<meta property="og:title" content={title} />
|
<meta property="og:title" content={title} />
|
||||||
<meta property="og:type" content="website" />
|
<meta property="og:type" content="website" />
|
||||||
@@ -189,28 +57,32 @@ export default (() => {
|
|||||||
<meta name="twitter:title" content={title} />
|
<meta name="twitter:title" content={title} />
|
||||||
<meta name="twitter:description" content={description} />
|
<meta name="twitter:description" content={description} />
|
||||||
<meta property="og:description" content={description} />
|
<meta property="og:description" content={description} />
|
||||||
<meta property="og:image:type" content={`image/${extension}`} />
|
|
||||||
<meta property="og:image:alt" content={description} />
|
<meta property="og:image:alt" content={description} />
|
||||||
{/* Dont set width and height if unknown (when using custom frontmatter image) */}
|
|
||||||
{!frontmatterImgUrl && (
|
{!usesCustomOgImage && (
|
||||||
<>
|
<>
|
||||||
<meta property="og:image:width" content={fullOptions.width.toString()} />
|
<meta property="og:image" content={ogImageDefaultPath} />
|
||||||
<meta property="og:image:height" content={fullOptions.height.toString()} />
|
<meta property="og:image:url" content={ogImageDefaultPath} />
|
||||||
|
<meta name="twitter:image" content={ogImageDefaultPath} />
|
||||||
|
<meta
|
||||||
|
property="og:image:type"
|
||||||
|
content={`image/${getFileExtension(ogImageDefaultPath) ?? "png"}`}
|
||||||
|
/>
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
<meta property="og:image:url" content={ogImagePath} />
|
|
||||||
{cfg.baseUrl && (
|
{cfg.baseUrl && (
|
||||||
<>
|
<>
|
||||||
<meta name="twitter:image" content={ogImagePath} />
|
|
||||||
<meta property="og:image" content={ogImagePath} />
|
|
||||||
<meta property="twitter:domain" content={cfg.baseUrl}></meta>
|
<meta property="twitter:domain" content={cfg.baseUrl}></meta>
|
||||||
<meta property="og:url" content={socialUrl}></meta>
|
<meta property="og:url" content={socialUrl}></meta>
|
||||||
<meta property="twitter:url" content={socialUrl}></meta>
|
<meta property="twitter:url" content={socialUrl}></meta>
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
<link rel="icon" href={iconPath} />
|
<link rel="icon" href={iconPath} />
|
||||||
<meta name="description" content={description} />
|
<meta name="description" content={description} />
|
||||||
<meta name="generator" content="Quartz" />
|
<meta name="generator" content="Quartz" />
|
||||||
|
|
||||||
{css.map((resource) => CSSResourceToStyleElement(resource, true))}
|
{css.map((resource) => CSSResourceToStyleElement(resource, true))}
|
||||||
{js
|
{js
|
||||||
.filter((resource) => resource.loadTime === "beforeDOMReady")
|
.filter((resource) => resource.loadTime === "beforeDOMReady")
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { FullSlug, resolveRelative } from "../util/path"
|
import { FullSlug, isFolderPath, resolveRelative } from "../util/path"
|
||||||
import { QuartzPluginData } from "../plugins/vfile"
|
import { QuartzPluginData } from "../plugins/vfile"
|
||||||
import { Date, getDate } from "./Date"
|
import { Date, getDate } from "./Date"
|
||||||
import { QuartzComponent, QuartzComponentProps } from "./types"
|
import { QuartzComponent, QuartzComponentProps } from "./types"
|
||||||
@@ -8,6 +8,13 @@ export type SortFn = (f1: QuartzPluginData, f2: QuartzPluginData) => number
|
|||||||
|
|
||||||
export function byDateAndAlphabetical(cfg: GlobalConfiguration): SortFn {
|
export function byDateAndAlphabetical(cfg: GlobalConfiguration): SortFn {
|
||||||
return (f1, f2) => {
|
return (f1, f2) => {
|
||||||
|
// Sort folders first
|
||||||
|
const f1IsFolder = isFolderPath(f1.slug ?? "")
|
||||||
|
const f2IsFolder = isFolderPath(f2.slug ?? "")
|
||||||
|
if (f1IsFolder && !f2IsFolder) return -1
|
||||||
|
if (!f1IsFolder && f2IsFolder) return 1
|
||||||
|
|
||||||
|
// If both are folders or both are files, sort by date/alphabetical
|
||||||
if (f1.dates && f2.dates) {
|
if (f1.dates && f2.dates) {
|
||||||
// sort descending
|
// sort descending
|
||||||
return getDate(cfg, f2)!.getTime() - getDate(cfg, f1)!.getTime()
|
return getDate(cfg, f2)!.getTime() - getDate(cfg, f1)!.getTime()
|
||||||
|
|||||||
@@ -1,16 +1,14 @@
|
|||||||
import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
|
import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
|
||||||
import path from "path"
|
|
||||||
|
|
||||||
import style from "../styles/listPage.scss"
|
import style from "../styles/listPage.scss"
|
||||||
import { byDateAndAlphabetical, PageList, SortFn } from "../PageList"
|
import { PageList, SortFn } from "../PageList"
|
||||||
import { stripSlashes, simplifySlug, joinSegments, FullSlug } from "../../util/path"
|
|
||||||
import { Root } from "hast"
|
import { Root } from "hast"
|
||||||
import { htmlToJsx } from "../../util/jsx"
|
import { htmlToJsx } from "../../util/jsx"
|
||||||
import { i18n } from "../../i18n"
|
import { i18n } from "../../i18n"
|
||||||
import { QuartzPluginData } from "../../plugins/vfile"
|
import { QuartzPluginData } from "../../plugins/vfile"
|
||||||
import { ComponentChildren } from "preact"
|
import { ComponentChildren } from "preact"
|
||||||
import { concatenateResources } from "../../util/resources"
|
import { concatenateResources } from "../../util/resources"
|
||||||
|
import { FileTrieNode } from "../../util/fileTrie"
|
||||||
interface FolderContentOptions {
|
interface FolderContentOptions {
|
||||||
/**
|
/**
|
||||||
* Whether to display number of folders
|
* Whether to display number of folders
|
||||||
@@ -27,51 +25,88 @@ const defaultOptions: FolderContentOptions = {
|
|||||||
|
|
||||||
export default ((opts?: Partial<FolderContentOptions>) => {
|
export default ((opts?: Partial<FolderContentOptions>) => {
|
||||||
const options: FolderContentOptions = { ...defaultOptions, ...opts }
|
const options: FolderContentOptions = { ...defaultOptions, ...opts }
|
||||||
|
let trie: FileTrieNode<
|
||||||
|
QuartzPluginData & {
|
||||||
|
slug: string
|
||||||
|
title: string
|
||||||
|
filePath: string
|
||||||
|
}
|
||||||
|
>
|
||||||
|
|
||||||
const FolderContent: QuartzComponent = (props: QuartzComponentProps) => {
|
const FolderContent: QuartzComponent = (props: QuartzComponentProps) => {
|
||||||
const { tree, fileData, allFiles, cfg } = props
|
const { tree, fileData, allFiles, cfg } = props
|
||||||
const folderSlug = stripSlashes(simplifySlug(fileData.slug!))
|
|
||||||
const folderParts = folderSlug.split(path.posix.sep)
|
|
||||||
|
|
||||||
const allPagesInFolder: QuartzPluginData[] = []
|
if (!trie) {
|
||||||
const allPagesInSubfolders: Map<FullSlug, QuartzPluginData[]> = new Map()
|
trie = new FileTrieNode([])
|
||||||
|
allFiles.forEach((file) => {
|
||||||
|
if (file.frontmatter) {
|
||||||
|
trie.add({
|
||||||
|
...file,
|
||||||
|
slug: file.slug!,
|
||||||
|
title: file.frontmatter.title,
|
||||||
|
filePath: file.filePath!,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
allFiles.forEach((file) => {
|
const folder = trie.findNode(fileData.slug!.split("/"))
|
||||||
const fileSlug = stripSlashes(simplifySlug(file.slug!))
|
if (!folder) {
|
||||||
const prefixed = fileSlug.startsWith(folderSlug) && fileSlug !== folderSlug
|
return null
|
||||||
const fileParts = fileSlug.split(path.posix.sep)
|
}
|
||||||
const isDirectChild = fileParts.length === folderParts.length + 1
|
|
||||||
|
|
||||||
if (!prefixed) {
|
const allPagesInFolder: QuartzPluginData[] =
|
||||||
return
|
folder.children
|
||||||
}
|
.map((node) => {
|
||||||
|
// regular file, proceed
|
||||||
|
if (node.data) {
|
||||||
|
return node.data
|
||||||
|
}
|
||||||
|
|
||||||
if (isDirectChild) {
|
if (node.isFolder && options.showSubfolders) {
|
||||||
allPagesInFolder.push(file)
|
// folders that dont have data need synthetic files
|
||||||
} else if (options.showSubfolders) {
|
const getMostRecentDates = (): QuartzPluginData["dates"] => {
|
||||||
const subfolderSlug = joinSegments(
|
let maybeDates: QuartzPluginData["dates"] | undefined = undefined
|
||||||
...fileParts.slice(0, folderParts.length + 1),
|
for (const child of node.children) {
|
||||||
) as FullSlug
|
if (child.data?.dates) {
|
||||||
const pagesInFolder = allPagesInSubfolders.get(subfolderSlug) || []
|
// compare all dates and assign to maybeDates if its more recent or its not set
|
||||||
allPagesInSubfolders.set(subfolderSlug, [...pagesInFolder, file])
|
if (!maybeDates) {
|
||||||
}
|
maybeDates = child.data.dates
|
||||||
})
|
} else {
|
||||||
|
if (child.data.dates.created > maybeDates.created) {
|
||||||
|
maybeDates.created = child.data.dates.created
|
||||||
|
}
|
||||||
|
|
||||||
allPagesInSubfolders.forEach((files, subfolderSlug) => {
|
if (child.data.dates.modified > maybeDates.modified) {
|
||||||
const hasIndex = allPagesInFolder.some(
|
maybeDates.modified = child.data.dates.modified
|
||||||
(file) => subfolderSlug === stripSlashes(simplifySlug(file.slug!)),
|
}
|
||||||
)
|
|
||||||
if (!hasIndex) {
|
if (child.data.dates.published > maybeDates.published) {
|
||||||
const subfolderDates = files.sort(byDateAndAlphabetical(cfg))[0].dates
|
maybeDates.published = child.data.dates.published
|
||||||
const subfolderTitle = subfolderSlug.split(path.posix.sep).at(-1)!
|
}
|
||||||
allPagesInFolder.push({
|
}
|
||||||
slug: subfolderSlug,
|
}
|
||||||
dates: subfolderDates,
|
}
|
||||||
frontmatter: { title: subfolderTitle, tags: ["folder"] },
|
return (
|
||||||
|
maybeDates ?? {
|
||||||
|
created: new Date(),
|
||||||
|
modified: new Date(),
|
||||||
|
published: new Date(),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
slug: node.slug,
|
||||||
|
dates: getMostRecentDates(),
|
||||||
|
frontmatter: {
|
||||||
|
title: node.displayName,
|
||||||
|
tags: [],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
})
|
})
|
||||||
}
|
.filter((page) => page !== undefined) ?? []
|
||||||
})
|
|
||||||
|
|
||||||
const cssClasses: string[] = fileData.frontmatter?.cssclasses ?? []
|
const cssClasses: string[] = fileData.frontmatter?.cssclasses ?? []
|
||||||
const classes = cssClasses.join(" ")
|
const classes = cssClasses.join(" ")
|
||||||
const listProps = {
|
const listProps = {
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ import { visit } from "unist-util-visit"
|
|||||||
import { Root, Element, ElementContent } from "hast"
|
import { Root, Element, ElementContent } from "hast"
|
||||||
import { GlobalConfiguration } from "../cfg"
|
import { GlobalConfiguration } from "../cfg"
|
||||||
import { i18n } from "../i18n"
|
import { i18n } from "../i18n"
|
||||||
import { QuartzPluginData } from "../plugins/vfile"
|
|
||||||
|
|
||||||
interface RenderComponents {
|
interface RenderComponents {
|
||||||
head: QuartzComponent
|
head: QuartzComponent
|
||||||
@@ -25,7 +24,6 @@ interface RenderComponents {
|
|||||||
const headerRegex = new RegExp(/h[1-6]/)
|
const headerRegex = new RegExp(/h[1-6]/)
|
||||||
export function pageResources(
|
export function pageResources(
|
||||||
baseDir: FullSlug | RelativeURL,
|
baseDir: FullSlug | RelativeURL,
|
||||||
fileData: QuartzPluginData,
|
|
||||||
staticResources: StaticResources,
|
staticResources: StaticResources,
|
||||||
): StaticResources {
|
): StaticResources {
|
||||||
const contentIndexPath = joinSegments(baseDir, "static/contentIndex.json")
|
const contentIndexPath = joinSegments(baseDir, "static/contentIndex.json")
|
||||||
@@ -65,17 +63,12 @@ export function pageResources(
|
|||||||
return resources
|
return resources
|
||||||
}
|
}
|
||||||
|
|
||||||
export function renderPage(
|
function renderTranscludes(
|
||||||
|
root: Root,
|
||||||
cfg: GlobalConfiguration,
|
cfg: GlobalConfiguration,
|
||||||
slug: FullSlug,
|
slug: FullSlug,
|
||||||
componentData: QuartzComponentProps,
|
componentData: QuartzComponentProps,
|
||||||
components: RenderComponents,
|
) {
|
||||||
pageResources: StaticResources,
|
|
||||||
): string {
|
|
||||||
// make a deep copy of the tree so we don't remove the transclusion references
|
|
||||||
// for the file cached in contentMap in build.ts
|
|
||||||
const root = clone(componentData.tree) as Root
|
|
||||||
|
|
||||||
// process transcludes in componentData
|
// process transcludes in componentData
|
||||||
visit(root, "element", (node, _index, _parent) => {
|
visit(root, "element", (node, _index, _parent) => {
|
||||||
if (node.tagName === "blockquote") {
|
if (node.tagName === "blockquote") {
|
||||||
@@ -191,6 +184,19 @@ export function renderPage(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
export function renderPage(
|
||||||
|
cfg: GlobalConfiguration,
|
||||||
|
slug: FullSlug,
|
||||||
|
componentData: QuartzComponentProps,
|
||||||
|
components: RenderComponents,
|
||||||
|
pageResources: StaticResources,
|
||||||
|
): string {
|
||||||
|
// make a deep copy of the tree so we don't remove the transclusion references
|
||||||
|
// for the file cached in contentMap in build.ts
|
||||||
|
const root = clone(componentData.tree) as Root
|
||||||
|
renderTranscludes(root, cfg, slug, componentData)
|
||||||
|
|
||||||
// set componentData.tree to the edited html that has transclusions rendered
|
// set componentData.tree to the edited html that has transclusions rendered
|
||||||
componentData.tree = root
|
componentData.tree = root
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ const emitThemeChangeEvent = (theme: "light" | "dark") => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
document.addEventListener("nav", () => {
|
document.addEventListener("nav", () => {
|
||||||
const switchTheme = (e: Event) => {
|
const switchTheme = () => {
|
||||||
const newTheme =
|
const newTheme =
|
||||||
document.documentElement.getAttribute("saved-theme") === "dark" ? "light" : "dark"
|
document.documentElement.getAttribute("saved-theme") === "dark" ? "light" : "dark"
|
||||||
document.documentElement.setAttribute("saved-theme", newTheme)
|
document.documentElement.setAttribute("saved-theme", newTheme)
|
||||||
|
|||||||
@@ -134,9 +134,9 @@ function createFolderNode(
|
|||||||
}
|
}
|
||||||
|
|
||||||
for (const child of node.children) {
|
for (const child of node.children) {
|
||||||
const childNode = child.data
|
const childNode = child.isFolder
|
||||||
? createFileNode(currentSlug, child)
|
? createFolderNode(currentSlug, child, opts)
|
||||||
: createFolderNode(currentSlug, child, opts)
|
: createFileNode(currentSlug, child)
|
||||||
ul.appendChild(childNode)
|
ul.appendChild(childNode)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -161,7 +161,7 @@ async function setupExplorer(currentSlug: FullSlug) {
|
|||||||
// Get folder state from local storage
|
// Get folder state from local storage
|
||||||
const storageTree = localStorage.getItem("fileTree")
|
const storageTree = localStorage.getItem("fileTree")
|
||||||
const serializedExplorerState = storageTree && opts.useSavedState ? JSON.parse(storageTree) : []
|
const serializedExplorerState = storageTree && opts.useSavedState ? JSON.parse(storageTree) : []
|
||||||
const oldIndex = new Map(
|
const oldIndex = new Map<string, boolean>(
|
||||||
serializedExplorerState.map((entry: FolderState) => [entry.path, entry.collapsed]),
|
serializedExplorerState.map((entry: FolderState) => [entry.path, entry.collapsed]),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -186,10 +186,14 @@ async function setupExplorer(currentSlug: FullSlug) {
|
|||||||
|
|
||||||
// Get folder paths for state management
|
// Get folder paths for state management
|
||||||
const folderPaths = trie.getFolderPaths()
|
const folderPaths = trie.getFolderPaths()
|
||||||
currentExplorerState = folderPaths.map((path) => ({
|
currentExplorerState = folderPaths.map((path) => {
|
||||||
path,
|
const previousState = oldIndex.get(path)
|
||||||
collapsed: oldIndex.get(path) === true,
|
return {
|
||||||
}))
|
path,
|
||||||
|
collapsed:
|
||||||
|
previousState === undefined ? opts.folderDefaultState === "collapsed" : previousState,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
const explorerUl = explorer.querySelector(".explorer-ul")
|
const explorerUl = explorer.querySelector(".explorer-ul")
|
||||||
if (!explorerUl) continue
|
if (!explorerUl) continue
|
||||||
@@ -259,15 +263,17 @@ document.addEventListener("nav", async (e: CustomEventMap["nav"]) => {
|
|||||||
await setupExplorer(currentSlug)
|
await setupExplorer(currentSlug)
|
||||||
|
|
||||||
// if mobile hamburger is visible, collapse by default
|
// if mobile hamburger is visible, collapse by default
|
||||||
for (const explorer of document.getElementsByClassName("mobile-explorer")) {
|
for (const explorer of document.getElementsByClassName("explorer")) {
|
||||||
if (explorer.checkVisibility()) {
|
const mobileExplorer = explorer.querySelector(".mobile-explorer")
|
||||||
|
if (!mobileExplorer) return
|
||||||
|
|
||||||
|
if (mobileExplorer.checkVisibility()) {
|
||||||
explorer.classList.add("collapsed")
|
explorer.classList.add("collapsed")
|
||||||
explorer.setAttribute("aria-expanded", "false")
|
explorer.setAttribute("aria-expanded", "false")
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
const hiddenUntilDoneLoading = document.querySelector("#mobile-explorer")
|
mobileExplorer.classList.remove("hide-until-loaded")
|
||||||
hiddenUntilDoneLoading?.classList.remove("hide-until-loaded")
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
function setFolderState(folderElement: HTMLElement, collapsed: boolean) {
|
function setFolderState(folderElement: HTMLElement, collapsed: boolean) {
|
||||||
|
|||||||
@@ -400,7 +400,6 @@ async function renderGraph(graph: HTMLElement, fullSlug: FullSlug) {
|
|||||||
})
|
})
|
||||||
.circle(0, 0, nodeRadius(n))
|
.circle(0, 0, nodeRadius(n))
|
||||||
.fill({ color: isTagNode ? computedStyleMap["--light"] : color(n) })
|
.fill({ color: isTagNode ? computedStyleMap["--light"] : color(n) })
|
||||||
.stroke({ width: isTagNode ? 2 : 0, color: color(n) })
|
|
||||||
.on("pointerover", (e) => {
|
.on("pointerover", (e) => {
|
||||||
updateHoverInfo(e.target.label)
|
updateHoverInfo(e.target.label)
|
||||||
oldLabelOpacity = label.alpha
|
oldLabelOpacity = label.alpha
|
||||||
@@ -416,6 +415,10 @@ async function renderGraph(graph: HTMLElement, fullSlug: FullSlug) {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
if (isTagNode) {
|
||||||
|
gfx.stroke({ width: 2, color: computedStyleMap["--tertiary"] })
|
||||||
|
}
|
||||||
|
|
||||||
nodesContainer.addChild(gfx)
|
nodesContainer.addChild(gfx)
|
||||||
labelsContainer.addChild(label)
|
labelsContainer.addChild(label)
|
||||||
|
|
||||||
|
|||||||
@@ -52,6 +52,8 @@
|
|||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
flex-shrink: 0;
|
flex-shrink: 0;
|
||||||
align-self: flex-start;
|
align-self: flex-start;
|
||||||
|
margin-top: auto;
|
||||||
|
margin-bottom: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
button.mobile-explorer {
|
button.mobile-explorer {
|
||||||
|
|||||||
@@ -1,118 +0,0 @@
|
|||||||
import test, { describe } from "node:test"
|
|
||||||
import DepGraph from "./depgraph"
|
|
||||||
import assert from "node:assert"
|
|
||||||
|
|
||||||
describe("DepGraph", () => {
|
|
||||||
test("getLeafNodes", () => {
|
|
||||||
const graph = new DepGraph<string>()
|
|
||||||
graph.addEdge("A", "B")
|
|
||||||
graph.addEdge("B", "C")
|
|
||||||
graph.addEdge("D", "C")
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodes("A"), new Set(["C"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodes("B"), new Set(["C"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodes("C"), new Set(["C"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodes("D"), new Set(["C"]))
|
|
||||||
})
|
|
||||||
|
|
||||||
describe("getLeafNodeAncestors", () => {
|
|
||||||
test("gets correct ancestors in a graph without cycles", () => {
|
|
||||||
const graph = new DepGraph<string>()
|
|
||||||
graph.addEdge("A", "B")
|
|
||||||
graph.addEdge("B", "C")
|
|
||||||
graph.addEdge("D", "B")
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("A"), new Set(["A", "B", "D"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("B"), new Set(["A", "B", "D"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("C"), new Set(["A", "B", "D"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("D"), new Set(["A", "B", "D"]))
|
|
||||||
})
|
|
||||||
|
|
||||||
test("gets correct ancestors in a graph with cycles", () => {
|
|
||||||
const graph = new DepGraph<string>()
|
|
||||||
graph.addEdge("A", "B")
|
|
||||||
graph.addEdge("B", "C")
|
|
||||||
graph.addEdge("C", "A")
|
|
||||||
graph.addEdge("C", "D")
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("A"), new Set(["A", "B", "C"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("B"), new Set(["A", "B", "C"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("C"), new Set(["A", "B", "C"]))
|
|
||||||
assert.deepStrictEqual(graph.getLeafNodeAncestors("D"), new Set(["A", "B", "C"]))
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe("mergeGraph", () => {
|
|
||||||
test("merges two graphs", () => {
|
|
||||||
const graph = new DepGraph<string>()
|
|
||||||
graph.addEdge("A.md", "A.html")
|
|
||||||
|
|
||||||
const other = new DepGraph<string>()
|
|
||||||
other.addEdge("B.md", "B.html")
|
|
||||||
|
|
||||||
graph.mergeGraph(other)
|
|
||||||
|
|
||||||
const expected = {
|
|
||||||
nodes: ["A.md", "A.html", "B.md", "B.html"],
|
|
||||||
edges: [
|
|
||||||
["A.md", "A.html"],
|
|
||||||
["B.md", "B.html"],
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.deepStrictEqual(graph.export(), expected)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe("updateIncomingEdgesForNode", () => {
|
|
||||||
test("merges when node exists", () => {
|
|
||||||
// A.md -> B.md -> B.html
|
|
||||||
const graph = new DepGraph<string>()
|
|
||||||
graph.addEdge("A.md", "B.md")
|
|
||||||
graph.addEdge("B.md", "B.html")
|
|
||||||
|
|
||||||
// B.md is edited so it removes the A.md transclusion
|
|
||||||
// and adds C.md transclusion
|
|
||||||
// C.md -> B.md
|
|
||||||
const other = new DepGraph<string>()
|
|
||||||
other.addEdge("C.md", "B.md")
|
|
||||||
other.addEdge("B.md", "B.html")
|
|
||||||
|
|
||||||
// A.md -> B.md removed, C.md -> B.md added
|
|
||||||
// C.md -> B.md -> B.html
|
|
||||||
graph.updateIncomingEdgesForNode(other, "B.md")
|
|
||||||
|
|
||||||
const expected = {
|
|
||||||
nodes: ["A.md", "B.md", "B.html", "C.md"],
|
|
||||||
edges: [
|
|
||||||
["B.md", "B.html"],
|
|
||||||
["C.md", "B.md"],
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.deepStrictEqual(graph.export(), expected)
|
|
||||||
})
|
|
||||||
|
|
||||||
test("adds node if it does not exist", () => {
|
|
||||||
// A.md -> B.md
|
|
||||||
const graph = new DepGraph<string>()
|
|
||||||
graph.addEdge("A.md", "B.md")
|
|
||||||
|
|
||||||
// Add a new file C.md that transcludes B.md
|
|
||||||
// B.md -> C.md
|
|
||||||
const other = new DepGraph<string>()
|
|
||||||
other.addEdge("B.md", "C.md")
|
|
||||||
|
|
||||||
// B.md -> C.md added
|
|
||||||
// A.md -> B.md -> C.md
|
|
||||||
graph.updateIncomingEdgesForNode(other, "C.md")
|
|
||||||
|
|
||||||
const expected = {
|
|
||||||
nodes: ["A.md", "B.md", "C.md"],
|
|
||||||
edges: [
|
|
||||||
["A.md", "B.md"],
|
|
||||||
["B.md", "C.md"],
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
assert.deepStrictEqual(graph.export(), expected)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,228 +0,0 @@
|
|||||||
export default class DepGraph<T> {
|
|
||||||
// node: incoming and outgoing edges
|
|
||||||
_graph = new Map<T, { incoming: Set<T>; outgoing: Set<T> }>()
|
|
||||||
|
|
||||||
constructor() {
|
|
||||||
this._graph = new Map()
|
|
||||||
}
|
|
||||||
|
|
||||||
export(): Object {
|
|
||||||
return {
|
|
||||||
nodes: this.nodes,
|
|
||||||
edges: this.edges,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
toString(): string {
|
|
||||||
return JSON.stringify(this.export(), null, 2)
|
|
||||||
}
|
|
||||||
|
|
||||||
// BASIC GRAPH OPERATIONS
|
|
||||||
|
|
||||||
get nodes(): T[] {
|
|
||||||
return Array.from(this._graph.keys())
|
|
||||||
}
|
|
||||||
|
|
||||||
get edges(): [T, T][] {
|
|
||||||
let edges: [T, T][] = []
|
|
||||||
this.forEachEdge((edge) => edges.push(edge))
|
|
||||||
return edges
|
|
||||||
}
|
|
||||||
|
|
||||||
hasNode(node: T): boolean {
|
|
||||||
return this._graph.has(node)
|
|
||||||
}
|
|
||||||
|
|
||||||
addNode(node: T): void {
|
|
||||||
if (!this._graph.has(node)) {
|
|
||||||
this._graph.set(node, { incoming: new Set(), outgoing: new Set() })
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove node and all edges connected to it
|
|
||||||
removeNode(node: T): void {
|
|
||||||
if (this._graph.has(node)) {
|
|
||||||
// first remove all edges so other nodes don't have references to this node
|
|
||||||
for (const target of this._graph.get(node)!.outgoing) {
|
|
||||||
this.removeEdge(node, target)
|
|
||||||
}
|
|
||||||
for (const source of this._graph.get(node)!.incoming) {
|
|
||||||
this.removeEdge(source, node)
|
|
||||||
}
|
|
||||||
this._graph.delete(node)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
forEachNode(callback: (node: T) => void): void {
|
|
||||||
for (const node of this._graph.keys()) {
|
|
||||||
callback(node)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
hasEdge(from: T, to: T): boolean {
|
|
||||||
return Boolean(this._graph.get(from)?.outgoing.has(to))
|
|
||||||
}
|
|
||||||
|
|
||||||
addEdge(from: T, to: T): void {
|
|
||||||
this.addNode(from)
|
|
||||||
this.addNode(to)
|
|
||||||
|
|
||||||
this._graph.get(from)!.outgoing.add(to)
|
|
||||||
this._graph.get(to)!.incoming.add(from)
|
|
||||||
}
|
|
||||||
|
|
||||||
removeEdge(from: T, to: T): void {
|
|
||||||
if (this._graph.has(from) && this._graph.has(to)) {
|
|
||||||
this._graph.get(from)!.outgoing.delete(to)
|
|
||||||
this._graph.get(to)!.incoming.delete(from)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns -1 if node does not exist
|
|
||||||
outDegree(node: T): number {
|
|
||||||
return this.hasNode(node) ? this._graph.get(node)!.outgoing.size : -1
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns -1 if node does not exist
|
|
||||||
inDegree(node: T): number {
|
|
||||||
return this.hasNode(node) ? this._graph.get(node)!.incoming.size : -1
|
|
||||||
}
|
|
||||||
|
|
||||||
forEachOutNeighbor(node: T, callback: (neighbor: T) => void): void {
|
|
||||||
this._graph.get(node)?.outgoing.forEach(callback)
|
|
||||||
}
|
|
||||||
|
|
||||||
forEachInNeighbor(node: T, callback: (neighbor: T) => void): void {
|
|
||||||
this._graph.get(node)?.incoming.forEach(callback)
|
|
||||||
}
|
|
||||||
|
|
||||||
forEachEdge(callback: (edge: [T, T]) => void): void {
|
|
||||||
for (const [source, { outgoing }] of this._graph.entries()) {
|
|
||||||
for (const target of outgoing) {
|
|
||||||
callback([source, target])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// DEPENDENCY ALGORITHMS
|
|
||||||
|
|
||||||
// Add all nodes and edges from other graph to this graph
|
|
||||||
mergeGraph(other: DepGraph<T>): void {
|
|
||||||
other.forEachEdge(([source, target]) => {
|
|
||||||
this.addNode(source)
|
|
||||||
this.addNode(target)
|
|
||||||
this.addEdge(source, target)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// For the node provided:
|
|
||||||
// If node does not exist, add it
|
|
||||||
// If an incoming edge was added in other, it is added in this graph
|
|
||||||
// If an incoming edge was deleted in other, it is deleted in this graph
|
|
||||||
updateIncomingEdgesForNode(other: DepGraph<T>, node: T): void {
|
|
||||||
this.addNode(node)
|
|
||||||
|
|
||||||
// Add edge if it is present in other
|
|
||||||
other.forEachInNeighbor(node, (neighbor) => {
|
|
||||||
this.addEdge(neighbor, node)
|
|
||||||
})
|
|
||||||
|
|
||||||
// For node provided, remove incoming edge if it is absent in other
|
|
||||||
this.forEachEdge(([source, target]) => {
|
|
||||||
if (target === node && !other.hasEdge(source, target)) {
|
|
||||||
this.removeEdge(source, target)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove all nodes that do not have any incoming or outgoing edges
|
|
||||||
// A node may be orphaned if the only node pointing to it was removed
|
|
||||||
removeOrphanNodes(): Set<T> {
|
|
||||||
let orphanNodes = new Set<T>()
|
|
||||||
|
|
||||||
this.forEachNode((node) => {
|
|
||||||
if (this.inDegree(node) === 0 && this.outDegree(node) === 0) {
|
|
||||||
orphanNodes.add(node)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
orphanNodes.forEach((node) => {
|
|
||||||
this.removeNode(node)
|
|
||||||
})
|
|
||||||
|
|
||||||
return orphanNodes
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get all leaf nodes (i.e. destination paths) reachable from the node provided
|
|
||||||
// Eg. if the graph is A -> B -> C
|
|
||||||
// D ---^
|
|
||||||
// and the node is B, this function returns [C]
|
|
||||||
getLeafNodes(node: T): Set<T> {
|
|
||||||
let stack: T[] = [node]
|
|
||||||
let visited = new Set<T>()
|
|
||||||
let leafNodes = new Set<T>()
|
|
||||||
|
|
||||||
// DFS
|
|
||||||
while (stack.length > 0) {
|
|
||||||
let node = stack.pop()!
|
|
||||||
|
|
||||||
// If the node is already visited, skip it
|
|
||||||
if (visited.has(node)) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
visited.add(node)
|
|
||||||
|
|
||||||
// Check if the node is a leaf node (i.e. destination path)
|
|
||||||
if (this.outDegree(node) === 0) {
|
|
||||||
leafNodes.add(node)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add all unvisited neighbors to the stack
|
|
||||||
this.forEachOutNeighbor(node, (neighbor) => {
|
|
||||||
if (!visited.has(neighbor)) {
|
|
||||||
stack.push(neighbor)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
return leafNodes
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get all ancestors of the leaf nodes reachable from the node provided
|
|
||||||
// Eg. if the graph is A -> B -> C
|
|
||||||
// D ---^
|
|
||||||
// and the node is B, this function returns [A, B, D]
|
|
||||||
getLeafNodeAncestors(node: T): Set<T> {
|
|
||||||
const leafNodes = this.getLeafNodes(node)
|
|
||||||
let visited = new Set<T>()
|
|
||||||
let upstreamNodes = new Set<T>()
|
|
||||||
|
|
||||||
// Backwards DFS for each leaf node
|
|
||||||
leafNodes.forEach((leafNode) => {
|
|
||||||
let stack: T[] = [leafNode]
|
|
||||||
|
|
||||||
while (stack.length > 0) {
|
|
||||||
let node = stack.pop()!
|
|
||||||
|
|
||||||
if (visited.has(node)) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
visited.add(node)
|
|
||||||
// Add node if it's not a leaf node (i.e. destination path)
|
|
||||||
// Assumes destination file cannot depend on another destination file
|
|
||||||
if (this.outDegree(node) !== 0) {
|
|
||||||
upstreamNodes.add(node)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add all unvisited parents to the stack
|
|
||||||
this.forEachInNeighbor(node, (parentNode) => {
|
|
||||||
if (!visited.has(parentNode)) {
|
|
||||||
stack.push(parentNode)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return upstreamNodes
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -3,13 +3,12 @@ import { QuartzComponentProps } from "../../components/types"
|
|||||||
import BodyConstructor from "../../components/Body"
|
import BodyConstructor from "../../components/Body"
|
||||||
import { pageResources, renderPage } from "../../components/renderPage"
|
import { pageResources, renderPage } from "../../components/renderPage"
|
||||||
import { FullPageLayout } from "../../cfg"
|
import { FullPageLayout } from "../../cfg"
|
||||||
import { FilePath, FullSlug } from "../../util/path"
|
import { FullSlug } from "../../util/path"
|
||||||
import { sharedPageComponents } from "../../../quartz.layout"
|
import { sharedPageComponents } from "../../../quartz.layout"
|
||||||
import { NotFound } from "../../components"
|
import { NotFound } from "../../components"
|
||||||
import { defaultProcessedContent } from "../vfile"
|
import { defaultProcessedContent } from "../vfile"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import { i18n } from "../../i18n"
|
import { i18n } from "../../i18n"
|
||||||
import DepGraph from "../../depgraph"
|
|
||||||
|
|
||||||
export const NotFoundPage: QuartzEmitterPlugin = () => {
|
export const NotFoundPage: QuartzEmitterPlugin = () => {
|
||||||
const opts: FullPageLayout = {
|
const opts: FullPageLayout = {
|
||||||
@@ -28,10 +27,7 @@ export const NotFoundPage: QuartzEmitterPlugin = () => {
|
|||||||
getQuartzComponents() {
|
getQuartzComponents() {
|
||||||
return [Head, Body, pageBody, Footer]
|
return [Head, Body, pageBody, Footer]
|
||||||
},
|
},
|
||||||
async getDependencyGraph(_ctx, _content, _resources) {
|
async *emit(ctx, _content, resources) {
|
||||||
return new DepGraph<FilePath>()
|
|
||||||
},
|
|
||||||
async emit(ctx, _content, resources): Promise<FilePath[]> {
|
|
||||||
const cfg = ctx.cfg.configuration
|
const cfg = ctx.cfg.configuration
|
||||||
const slug = "404" as FullSlug
|
const slug = "404" as FullSlug
|
||||||
|
|
||||||
@@ -44,7 +40,7 @@ export const NotFoundPage: QuartzEmitterPlugin = () => {
|
|||||||
description: notFound,
|
description: notFound,
|
||||||
frontmatter: { title: notFound, tags: [] },
|
frontmatter: { title: notFound, tags: [] },
|
||||||
})
|
})
|
||||||
const externalResources = pageResources(path, vfile.data, resources)
|
const externalResources = pageResources(path, resources)
|
||||||
const componentData: QuartzComponentProps = {
|
const componentData: QuartzComponentProps = {
|
||||||
ctx,
|
ctx,
|
||||||
fileData: vfile.data,
|
fileData: vfile.data,
|
||||||
@@ -55,14 +51,13 @@ export const NotFoundPage: QuartzEmitterPlugin = () => {
|
|||||||
allFiles: [],
|
allFiles: [],
|
||||||
}
|
}
|
||||||
|
|
||||||
return [
|
yield write({
|
||||||
await write({
|
ctx,
|
||||||
ctx,
|
content: renderPage(cfg, slug, componentData, opts, externalResources),
|
||||||
content: renderPage(cfg, slug, componentData, opts, externalResources),
|
slug,
|
||||||
slug,
|
ext: ".html",
|
||||||
ext: ".html",
|
})
|
||||||
}),
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
|
async *partialEmit() {},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,52 +1,48 @@
|
|||||||
import { FilePath, joinSegments, resolveRelative, simplifySlug } from "../../util/path"
|
import { resolveRelative, simplifySlug } from "../../util/path"
|
||||||
import { QuartzEmitterPlugin } from "../types"
|
import { QuartzEmitterPlugin } from "../types"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import DepGraph from "../../depgraph"
|
import { BuildCtx } from "../../util/ctx"
|
||||||
import { getAliasSlugs } from "../transformers/frontmatter"
|
import { VFile } from "vfile"
|
||||||
|
|
||||||
|
async function* processFile(ctx: BuildCtx, file: VFile) {
|
||||||
|
const ogSlug = simplifySlug(file.data.slug!)
|
||||||
|
|
||||||
|
for (const slug of file.data.aliases ?? []) {
|
||||||
|
const redirUrl = resolveRelative(slug, file.data.slug!)
|
||||||
|
yield write({
|
||||||
|
ctx,
|
||||||
|
content: `
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en-us">
|
||||||
|
<head>
|
||||||
|
<title>${ogSlug}</title>
|
||||||
|
<link rel="canonical" href="${redirUrl}">
|
||||||
|
<meta name="robots" content="noindex">
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="refresh" content="0; url=${redirUrl}">
|
||||||
|
</head>
|
||||||
|
</html>
|
||||||
|
`,
|
||||||
|
slug,
|
||||||
|
ext: ".html",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
export const AliasRedirects: QuartzEmitterPlugin = () => ({
|
export const AliasRedirects: QuartzEmitterPlugin = () => ({
|
||||||
name: "AliasRedirects",
|
name: "AliasRedirects",
|
||||||
async getDependencyGraph(ctx, content, _resources) {
|
async *emit(ctx, content) {
|
||||||
const graph = new DepGraph<FilePath>()
|
|
||||||
|
|
||||||
const { argv } = ctx
|
|
||||||
for (const [_tree, file] of content) {
|
for (const [_tree, file] of content) {
|
||||||
for (const slug of getAliasSlugs(file.data.frontmatter?.aliases ?? [], argv, file)) {
|
yield* processFile(ctx, file)
|
||||||
graph.addEdge(file.data.filePath!, joinSegments(argv.output, slug + ".html") as FilePath)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
},
|
||||||
async emit(ctx, content, _resources): Promise<FilePath[]> {
|
async *partialEmit(ctx, _content, _resources, changeEvents) {
|
||||||
const fps: FilePath[] = []
|
for (const changeEvent of changeEvents) {
|
||||||
|
if (!changeEvent.file) continue
|
||||||
for (const [_tree, file] of content) {
|
if (changeEvent.type === "add" || changeEvent.type === "change") {
|
||||||
const ogSlug = simplifySlug(file.data.slug!)
|
// add new ones if this file still exists
|
||||||
|
yield* processFile(ctx, changeEvent.file)
|
||||||
for (const slug of file.data.aliases ?? []) {
|
|
||||||
const redirUrl = resolveRelative(slug, file.data.slug!)
|
|
||||||
const fp = await write({
|
|
||||||
ctx,
|
|
||||||
content: `
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en-us">
|
|
||||||
<head>
|
|
||||||
<title>${ogSlug}</title>
|
|
||||||
<link rel="canonical" href="${redirUrl}">
|
|
||||||
<meta name="robots" content="noindex">
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<meta http-equiv="refresh" content="0; url=${redirUrl}">
|
|
||||||
</head>
|
|
||||||
</html>
|
|
||||||
`,
|
|
||||||
slug,
|
|
||||||
ext: ".html",
|
|
||||||
})
|
|
||||||
|
|
||||||
fps.push(fp)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return fps
|
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ import { QuartzEmitterPlugin } from "../types"
|
|||||||
import path from "path"
|
import path from "path"
|
||||||
import fs from "fs"
|
import fs from "fs"
|
||||||
import { glob } from "../../util/glob"
|
import { glob } from "../../util/glob"
|
||||||
import DepGraph from "../../depgraph"
|
|
||||||
import { Argv } from "../../util/ctx"
|
import { Argv } from "../../util/ctx"
|
||||||
import { QuartzConfig } from "../../cfg"
|
import { QuartzConfig } from "../../cfg"
|
||||||
|
|
||||||
@@ -12,44 +11,42 @@ const filesToCopy = async (argv: Argv, cfg: QuartzConfig) => {
|
|||||||
return await glob("**", argv.directory, ["**/*.md", ...cfg.configuration.ignorePatterns])
|
return await glob("**", argv.directory, ["**/*.md", ...cfg.configuration.ignorePatterns])
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const copyFile = async (argv: Argv, fp: FilePath) => {
|
||||||
|
const src = joinSegments(argv.directory, fp) as FilePath
|
||||||
|
|
||||||
|
const name = slugifyFilePath(fp)
|
||||||
|
const dest = joinSegments(argv.output, name) as FilePath
|
||||||
|
|
||||||
|
// ensure dir exists
|
||||||
|
const dir = path.dirname(dest) as FilePath
|
||||||
|
await fs.promises.mkdir(dir, { recursive: true })
|
||||||
|
|
||||||
|
await fs.promises.copyFile(src, dest)
|
||||||
|
return dest
|
||||||
|
}
|
||||||
|
|
||||||
export const Assets: QuartzEmitterPlugin = () => {
|
export const Assets: QuartzEmitterPlugin = () => {
|
||||||
return {
|
return {
|
||||||
name: "Assets",
|
name: "Assets",
|
||||||
async getDependencyGraph(ctx, _content, _resources) {
|
async *emit({ argv, cfg }) {
|
||||||
const { argv, cfg } = ctx
|
|
||||||
const graph = new DepGraph<FilePath>()
|
|
||||||
|
|
||||||
const fps = await filesToCopy(argv, cfg)
|
const fps = await filesToCopy(argv, cfg)
|
||||||
|
|
||||||
for (const fp of fps) {
|
for (const fp of fps) {
|
||||||
const ext = path.extname(fp)
|
yield copyFile(argv, fp)
|
||||||
const src = joinSegments(argv.directory, fp) as FilePath
|
|
||||||
const name = (slugifyFilePath(fp as FilePath, true) + ext) as FilePath
|
|
||||||
|
|
||||||
const dest = joinSegments(argv.output, name) as FilePath
|
|
||||||
|
|
||||||
graph.addEdge(src, dest)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
},
|
||||||
async emit({ argv, cfg }, _content, _resources): Promise<FilePath[]> {
|
async *partialEmit(ctx, _content, _resources, changeEvents) {
|
||||||
const assetsPath = argv.output
|
for (const changeEvent of changeEvents) {
|
||||||
const fps = await filesToCopy(argv, cfg)
|
const ext = path.extname(changeEvent.path)
|
||||||
const res: FilePath[] = []
|
if (ext === ".md") continue
|
||||||
for (const fp of fps) {
|
|
||||||
const ext = path.extname(fp)
|
|
||||||
const src = joinSegments(argv.directory, fp) as FilePath
|
|
||||||
const name = (slugifyFilePath(fp as FilePath, true) + ext) as FilePath
|
|
||||||
|
|
||||||
const dest = joinSegments(assetsPath, name) as FilePath
|
if (changeEvent.type === "add" || changeEvent.type === "change") {
|
||||||
const dir = path.dirname(dest) as FilePath
|
yield copyFile(ctx.argv, changeEvent.path)
|
||||||
await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists
|
} else if (changeEvent.type === "delete") {
|
||||||
await fs.promises.copyFile(src, dest)
|
const name = slugifyFilePath(changeEvent.path)
|
||||||
res.push(dest)
|
const dest = joinSegments(ctx.argv.output, name) as FilePath
|
||||||
|
await fs.promises.unlink(dest)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return res
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ import { FilePath, joinSegments } from "../../util/path"
|
|||||||
import { QuartzEmitterPlugin } from "../types"
|
import { QuartzEmitterPlugin } from "../types"
|
||||||
import fs from "fs"
|
import fs from "fs"
|
||||||
import chalk from "chalk"
|
import chalk from "chalk"
|
||||||
import DepGraph from "../../depgraph"
|
|
||||||
|
|
||||||
export function extractDomainFromBaseUrl(baseUrl: string) {
|
export function extractDomainFromBaseUrl(baseUrl: string) {
|
||||||
const url = new URL(`https://${baseUrl}`)
|
const url = new URL(`https://${baseUrl}`)
|
||||||
@@ -11,10 +10,7 @@ export function extractDomainFromBaseUrl(baseUrl: string) {
|
|||||||
|
|
||||||
export const CNAME: QuartzEmitterPlugin = () => ({
|
export const CNAME: QuartzEmitterPlugin = () => ({
|
||||||
name: "CNAME",
|
name: "CNAME",
|
||||||
async getDependencyGraph(_ctx, _content, _resources) {
|
async emit({ argv, cfg }) {
|
||||||
return new DepGraph<FilePath>()
|
|
||||||
},
|
|
||||||
async emit({ argv, cfg }, _content, _resources): Promise<FilePath[]> {
|
|
||||||
if (!cfg.configuration.baseUrl) {
|
if (!cfg.configuration.baseUrl) {
|
||||||
console.warn(chalk.yellow("CNAME emitter requires `baseUrl` to be set in your configuration"))
|
console.warn(chalk.yellow("CNAME emitter requires `baseUrl` to be set in your configuration"))
|
||||||
return []
|
return []
|
||||||
@@ -24,7 +20,8 @@ export const CNAME: QuartzEmitterPlugin = () => ({
|
|||||||
if (!content) {
|
if (!content) {
|
||||||
return []
|
return []
|
||||||
}
|
}
|
||||||
fs.writeFileSync(path, content)
|
await fs.promises.writeFile(path, content)
|
||||||
return [path] as FilePath[]
|
return [path] as FilePath[]
|
||||||
},
|
},
|
||||||
|
async *partialEmit() {},
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { FilePath, FullSlug, joinSegments } from "../../util/path"
|
import { FullSlug, joinSegments } from "../../util/path"
|
||||||
import { QuartzEmitterPlugin } from "../types"
|
import { QuartzEmitterPlugin } from "../types"
|
||||||
|
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
@@ -9,11 +9,10 @@ import styles from "../../styles/custom.scss"
|
|||||||
import popoverStyle from "../../components/styles/popover.scss"
|
import popoverStyle from "../../components/styles/popover.scss"
|
||||||
import { BuildCtx } from "../../util/ctx"
|
import { BuildCtx } from "../../util/ctx"
|
||||||
import { QuartzComponent } from "../../components/types"
|
import { QuartzComponent } from "../../components/types"
|
||||||
import { googleFontHref, joinStyles } from "../../util/theme"
|
import { googleFontHref, joinStyles, processGoogleFonts } from "../../util/theme"
|
||||||
import { Features, transform } from "lightningcss"
|
import { Features, transform } from "lightningcss"
|
||||||
import { transform as transpile } from "esbuild"
|
import { transform as transpile } from "esbuild"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import DepGraph from "../../depgraph"
|
|
||||||
|
|
||||||
type ComponentResources = {
|
type ComponentResources = {
|
||||||
css: string[]
|
css: string[]
|
||||||
@@ -86,7 +85,7 @@ function addGlobalPageResources(ctx: BuildCtx, componentResources: ComponentReso
|
|||||||
componentResources.afterDOMLoaded.push(`
|
componentResources.afterDOMLoaded.push(`
|
||||||
const gtagScript = document.createElement("script")
|
const gtagScript = document.createElement("script")
|
||||||
gtagScript.src = "https://www.googletagmanager.com/gtag/js?id=${tagId}"
|
gtagScript.src = "https://www.googletagmanager.com/gtag/js?id=${tagId}"
|
||||||
gtagScript.async = true
|
gtagScript.defer = true
|
||||||
document.head.appendChild(gtagScript)
|
document.head.appendChild(gtagScript)
|
||||||
|
|
||||||
window.dataLayer = window.dataLayer || [];
|
window.dataLayer = window.dataLayer || [];
|
||||||
@@ -121,7 +120,7 @@ function addGlobalPageResources(ctx: BuildCtx, componentResources: ComponentReso
|
|||||||
umamiScript.src = "${cfg.analytics.host ?? "https://analytics.umami.is"}/script.js"
|
umamiScript.src = "${cfg.analytics.host ?? "https://analytics.umami.is"}/script.js"
|
||||||
umamiScript.setAttribute("data-website-id", "${cfg.analytics.websiteId}")
|
umamiScript.setAttribute("data-website-id", "${cfg.analytics.websiteId}")
|
||||||
umamiScript.setAttribute("data-auto-track", "false")
|
umamiScript.setAttribute("data-auto-track", "false")
|
||||||
umamiScript.async = true
|
umamiScript.defer = true
|
||||||
document.head.appendChild(umamiScript)
|
document.head.appendChild(umamiScript)
|
||||||
|
|
||||||
document.addEventListener("nav", () => {
|
document.addEventListener("nav", () => {
|
||||||
@@ -132,7 +131,7 @@ function addGlobalPageResources(ctx: BuildCtx, componentResources: ComponentReso
|
|||||||
componentResources.afterDOMLoaded.push(`
|
componentResources.afterDOMLoaded.push(`
|
||||||
const goatcounterScript = document.createElement("script")
|
const goatcounterScript = document.createElement("script")
|
||||||
goatcounterScript.src = "${cfg.analytics.scriptSrc ?? "https://gc.zgo.at/count.js"}"
|
goatcounterScript.src = "${cfg.analytics.scriptSrc ?? "https://gc.zgo.at/count.js"}"
|
||||||
goatcounterScript.async = true
|
goatcounterScript.defer = true
|
||||||
goatcounterScript.setAttribute("data-goatcounter",
|
goatcounterScript.setAttribute("data-goatcounter",
|
||||||
"https://${cfg.analytics.websiteId}.${cfg.analytics.host ?? "goatcounter.com"}/count")
|
"https://${cfg.analytics.websiteId}.${cfg.analytics.host ?? "goatcounter.com"}/count")
|
||||||
document.head.appendChild(goatcounterScript)
|
document.head.appendChild(goatcounterScript)
|
||||||
@@ -173,14 +172,13 @@ function addGlobalPageResources(ctx: BuildCtx, componentResources: ComponentReso
|
|||||||
const cabinScript = document.createElement("script")
|
const cabinScript = document.createElement("script")
|
||||||
cabinScript.src = "${cfg.analytics.host ?? "https://scripts.withcabin.com"}/hello.js"
|
cabinScript.src = "${cfg.analytics.host ?? "https://scripts.withcabin.com"}/hello.js"
|
||||||
cabinScript.defer = true
|
cabinScript.defer = true
|
||||||
cabinScript.async = true
|
|
||||||
document.head.appendChild(cabinScript)
|
document.head.appendChild(cabinScript)
|
||||||
`)
|
`)
|
||||||
} else if (cfg.analytics?.provider === "clarity") {
|
} else if (cfg.analytics?.provider === "clarity") {
|
||||||
componentResources.afterDOMLoaded.push(`
|
componentResources.afterDOMLoaded.push(`
|
||||||
const clarityScript = document.createElement("script")
|
const clarityScript = document.createElement("script")
|
||||||
clarityScript.innerHTML= \`(function(c,l,a,r,i,t,y){c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
|
clarityScript.innerHTML= \`(function(c,l,a,r,i,t,y){c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
|
||||||
t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
|
t=l.createElement(r);t.defer=1;t.src="https://www.clarity.ms/tag/"+i;
|
||||||
y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
|
y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
|
||||||
})(window, document, "clarity", "script", "${cfg.analytics.projectId}");\`
|
})(window, document, "clarity", "script", "${cfg.analytics.projectId}");\`
|
||||||
document.head.appendChild(clarityScript)
|
document.head.appendChild(clarityScript)
|
||||||
@@ -204,11 +202,7 @@ function addGlobalPageResources(ctx: BuildCtx, componentResources: ComponentReso
|
|||||||
export const ComponentResources: QuartzEmitterPlugin = () => {
|
export const ComponentResources: QuartzEmitterPlugin = () => {
|
||||||
return {
|
return {
|
||||||
name: "ComponentResources",
|
name: "ComponentResources",
|
||||||
async getDependencyGraph(_ctx, _content, _resources) {
|
async *emit(ctx, _content, _resources) {
|
||||||
return new DepGraph<FilePath>()
|
|
||||||
},
|
|
||||||
async emit(ctx, _content, _resources): Promise<FilePath[]> {
|
|
||||||
const promises: Promise<FilePath>[] = []
|
|
||||||
const cfg = ctx.cfg.configuration
|
const cfg = ctx.cfg.configuration
|
||||||
// component specific scripts and styles
|
// component specific scripts and styles
|
||||||
const componentResources = getComponentResources(ctx)
|
const componentResources = getComponentResources(ctx)
|
||||||
@@ -217,42 +211,35 @@ export const ComponentResources: QuartzEmitterPlugin = () => {
|
|||||||
// let the user do it themselves in css
|
// let the user do it themselves in css
|
||||||
} else if (cfg.theme.fontOrigin === "googleFonts" && !cfg.theme.cdnCaching) {
|
} else if (cfg.theme.fontOrigin === "googleFonts" && !cfg.theme.cdnCaching) {
|
||||||
// when cdnCaching is true, we link to google fonts in Head.tsx
|
// 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
|
if (!cfg.baseUrl) {
|
||||||
|
throw new Error(
|
||||||
googleFontsStyleSheet = await (
|
"baseUrl must be defined when using Google Fonts without cfg.theme.cdnCaching",
|
||||||
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`,
|
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
promises.push(
|
const { processedStylesheet, fontFiles } = await processGoogleFonts(
|
||||||
fetch(url)
|
googleFontsStyleSheet,
|
||||||
.then((res) => {
|
cfg.baseUrl,
|
||||||
if (!res.ok) {
|
)
|
||||||
throw new Error(`Failed to fetch font`)
|
googleFontsStyleSheet = processedStylesheet
|
||||||
}
|
|
||||||
return res.arrayBuffer()
|
// Download and save font files
|
||||||
})
|
for (const fontFile of fontFiles) {
|
||||||
.then((buf) =>
|
const res = await fetch(fontFile.url)
|
||||||
write({
|
if (!res.ok) {
|
||||||
ctx,
|
throw new Error(`Failed to fetch font ${fontFile.filename}`)
|
||||||
slug: joinSegments("static", "fonts", filename) as FullSlug,
|
}
|
||||||
ext: `.${ext}`,
|
|
||||||
content: Buffer.from(buf),
|
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 +254,45 @@ export const ComponentResources: QuartzEmitterPlugin = () => {
|
|||||||
...componentResources.css,
|
...componentResources.css,
|
||||||
styles,
|
styles,
|
||||||
)
|
)
|
||||||
|
|
||||||
const [prescript, postscript] = await Promise.all([
|
const [prescript, postscript] = await Promise.all([
|
||||||
joinScripts(componentResources.beforeDOMLoaded),
|
joinScripts(componentResources.beforeDOMLoaded),
|
||||||
joinScripts(componentResources.afterDOMLoaded),
|
joinScripts(componentResources.afterDOMLoaded),
|
||||||
])
|
])
|
||||||
|
|
||||||
promises.push(
|
yield write({
|
||||||
write({
|
ctx,
|
||||||
ctx,
|
slug: "index" as FullSlug,
|
||||||
slug: "index" as FullSlug,
|
ext: ".css",
|
||||||
ext: ".css",
|
content: transform({
|
||||||
content: transform({
|
filename: "index.css",
|
||||||
filename: "index.css",
|
code: Buffer.from(stylesheet),
|
||||||
code: Buffer.from(stylesheet),
|
minify: true,
|
||||||
minify: true,
|
targets: {
|
||||||
targets: {
|
safari: (15 << 16) | (6 << 8), // 15.6
|
||||||
safari: (15 << 16) | (6 << 8), // 15.6
|
ios_saf: (15 << 16) | (6 << 8), // 15.6
|
||||||
ios_saf: (15 << 16) | (6 << 8), // 15.6
|
edge: 115 << 16,
|
||||||
edge: 115 << 16,
|
firefox: 102 << 16,
|
||||||
firefox: 102 << 16,
|
chrome: 109 << 16,
|
||||||
chrome: 109 << 16,
|
},
|
||||||
},
|
include: Features.MediaQueries,
|
||||||
include: Features.MediaQueries,
|
}).code.toString(),
|
||||||
}).code.toString(),
|
})
|
||||||
}),
|
|
||||||
write({
|
|
||||||
ctx,
|
|
||||||
slug: "prescript" as FullSlug,
|
|
||||||
ext: ".js",
|
|
||||||
content: prescript,
|
|
||||||
}),
|
|
||||||
write({
|
|
||||||
ctx,
|
|
||||||
slug: "postscript" as FullSlug,
|
|
||||||
ext: ".js",
|
|
||||||
content: postscript,
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
return await Promise.all(promises)
|
yield write({
|
||||||
|
ctx,
|
||||||
|
slug: "prescript" as FullSlug,
|
||||||
|
ext: ".js",
|
||||||
|
content: prescript,
|
||||||
|
})
|
||||||
|
|
||||||
|
yield write({
|
||||||
|
ctx,
|
||||||
|
slug: "postscript" as FullSlug,
|
||||||
|
ext: ".js",
|
||||||
|
content: postscript,
|
||||||
|
})
|
||||||
},
|
},
|
||||||
|
async *partialEmit() {},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,11 +7,11 @@ import { QuartzEmitterPlugin } from "../types"
|
|||||||
import { toHtml } from "hast-util-to-html"
|
import { toHtml } from "hast-util-to-html"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import { i18n } from "../../i18n"
|
import { i18n } from "../../i18n"
|
||||||
import DepGraph from "../../depgraph"
|
|
||||||
|
|
||||||
export type ContentIndexMap = Map<FullSlug, ContentDetails>
|
export type ContentIndexMap = Map<FullSlug, ContentDetails>
|
||||||
export type ContentDetails = {
|
export type ContentDetails = {
|
||||||
slug: FullSlug
|
slug: FullSlug
|
||||||
|
filePath: FilePath
|
||||||
title: string
|
title: string
|
||||||
links: SimpleSlug[]
|
links: SimpleSlug[]
|
||||||
tags: string[]
|
tags: string[]
|
||||||
@@ -96,29 +96,8 @@ export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
|
|||||||
opts = { ...defaultOptions, ...opts }
|
opts = { ...defaultOptions, ...opts }
|
||||||
return {
|
return {
|
||||||
name: "ContentIndex",
|
name: "ContentIndex",
|
||||||
async getDependencyGraph(ctx, content, _resources) {
|
async *emit(ctx, content) {
|
||||||
const graph = new DepGraph<FilePath>()
|
|
||||||
|
|
||||||
for (const [_tree, file] of content) {
|
|
||||||
const sourcePath = file.data.filePath!
|
|
||||||
|
|
||||||
graph.addEdge(
|
|
||||||
sourcePath,
|
|
||||||
joinSegments(ctx.argv.output, "static/contentIndex.json") as FilePath,
|
|
||||||
)
|
|
||||||
if (opts?.enableSiteMap) {
|
|
||||||
graph.addEdge(sourcePath, joinSegments(ctx.argv.output, "sitemap.xml") as FilePath)
|
|
||||||
}
|
|
||||||
if (opts?.enableRSS) {
|
|
||||||
graph.addEdge(sourcePath, joinSegments(ctx.argv.output, "index.xml") as FilePath)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
|
||||||
async emit(ctx, content, _resources) {
|
|
||||||
const cfg = ctx.cfg.configuration
|
const cfg = ctx.cfg.configuration
|
||||||
const emitted: FilePath[] = []
|
|
||||||
const linkIndex: ContentIndexMap = new Map()
|
const linkIndex: ContentIndexMap = new Map()
|
||||||
for (const [tree, file] of content) {
|
for (const [tree, file] of content) {
|
||||||
const slug = file.data.slug!
|
const slug = file.data.slug!
|
||||||
@@ -126,6 +105,7 @@ export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
|
|||||||
if (opts?.includeEmptyFiles || (file.data.text && file.data.text !== "")) {
|
if (opts?.includeEmptyFiles || (file.data.text && file.data.text !== "")) {
|
||||||
linkIndex.set(slug, {
|
linkIndex.set(slug, {
|
||||||
slug,
|
slug,
|
||||||
|
filePath: file.data.relativePath!,
|
||||||
title: file.data.frontmatter?.title!,
|
title: file.data.frontmatter?.title!,
|
||||||
links: file.data.links ?? [],
|
links: file.data.links ?? [],
|
||||||
tags: file.data.frontmatter?.tags ?? [],
|
tags: file.data.frontmatter?.tags ?? [],
|
||||||
@@ -140,25 +120,21 @@ export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (opts?.enableSiteMap) {
|
if (opts?.enableSiteMap) {
|
||||||
emitted.push(
|
yield write({
|
||||||
await write({
|
ctx,
|
||||||
ctx,
|
content: generateSiteMap(cfg, linkIndex),
|
||||||
content: generateSiteMap(cfg, linkIndex),
|
slug: "sitemap" as FullSlug,
|
||||||
slug: "sitemap" as FullSlug,
|
ext: ".xml",
|
||||||
ext: ".xml",
|
})
|
||||||
}),
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (opts?.enableRSS) {
|
if (opts?.enableRSS) {
|
||||||
emitted.push(
|
yield write({
|
||||||
await write({
|
ctx,
|
||||||
ctx,
|
content: generateRSSFeed(cfg, linkIndex, opts.rssLimit),
|
||||||
content: generateRSSFeed(cfg, linkIndex, opts.rssLimit),
|
slug: (opts?.rssSlug ?? "index") as FullSlug,
|
||||||
slug: (opts?.rssSlug ?? "index") as FullSlug,
|
ext: ".xml",
|
||||||
ext: ".xml",
|
})
|
||||||
}),
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const fp = joinSegments("static", "contentIndex") as FullSlug
|
const fp = joinSegments("static", "contentIndex") as FullSlug
|
||||||
@@ -173,16 +149,12 @@ export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
|
|||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
|
|
||||||
emitted.push(
|
yield write({
|
||||||
await write({
|
ctx,
|
||||||
ctx,
|
content: JSON.stringify(simplifiedIndex),
|
||||||
content: JSON.stringify(simplifiedIndex),
|
slug: fp,
|
||||||
slug: fp,
|
ext: ".json",
|
||||||
ext: ".json",
|
})
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
return emitted
|
|
||||||
},
|
},
|
||||||
externalResources: (ctx) => {
|
externalResources: (ctx) => {
|
||||||
if (opts?.enableRSS) {
|
if (opts?.enableRSS) {
|
||||||
|
|||||||
@@ -1,54 +1,48 @@
|
|||||||
import path from "path"
|
import path from "path"
|
||||||
import { visit } from "unist-util-visit"
|
|
||||||
import { Root } from "hast"
|
|
||||||
import { VFile } from "vfile"
|
|
||||||
import { QuartzEmitterPlugin } from "../types"
|
import { QuartzEmitterPlugin } from "../types"
|
||||||
import { QuartzComponentProps } from "../../components/types"
|
import { QuartzComponentProps } from "../../components/types"
|
||||||
import HeaderConstructor from "../../components/Header"
|
import HeaderConstructor from "../../components/Header"
|
||||||
import BodyConstructor from "../../components/Body"
|
import BodyConstructor from "../../components/Body"
|
||||||
import { pageResources, renderPage } from "../../components/renderPage"
|
import { pageResources, renderPage } from "../../components/renderPage"
|
||||||
import { FullPageLayout } from "../../cfg"
|
import { FullPageLayout } from "../../cfg"
|
||||||
import { Argv } from "../../util/ctx"
|
import { pathToRoot } from "../../util/path"
|
||||||
import { FilePath, isRelativeURL, joinSegments, pathToRoot } from "../../util/path"
|
|
||||||
import { defaultContentPageLayout, sharedPageComponents } from "../../../quartz.layout"
|
import { defaultContentPageLayout, sharedPageComponents } from "../../../quartz.layout"
|
||||||
import { Content } from "../../components"
|
import { Content } from "../../components"
|
||||||
import chalk from "chalk"
|
import chalk from "chalk"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import DepGraph from "../../depgraph"
|
import { BuildCtx } from "../../util/ctx"
|
||||||
|
import { Node } from "unist"
|
||||||
|
import { StaticResources } from "../../util/resources"
|
||||||
|
import { QuartzPluginData } from "../vfile"
|
||||||
|
|
||||||
// get all the dependencies for the markdown file
|
async function processContent(
|
||||||
// eg. images, scripts, stylesheets, transclusions
|
ctx: BuildCtx,
|
||||||
const parseDependencies = (argv: Argv, hast: Root, file: VFile): string[] => {
|
tree: Node,
|
||||||
const dependencies: string[] = []
|
fileData: QuartzPluginData,
|
||||||
|
allFiles: QuartzPluginData[],
|
||||||
|
opts: FullPageLayout,
|
||||||
|
resources: StaticResources,
|
||||||
|
) {
|
||||||
|
const slug = fileData.slug!
|
||||||
|
const cfg = ctx.cfg.configuration
|
||||||
|
const externalResources = pageResources(pathToRoot(slug), resources)
|
||||||
|
const componentData: QuartzComponentProps = {
|
||||||
|
ctx,
|
||||||
|
fileData,
|
||||||
|
externalResources,
|
||||||
|
cfg,
|
||||||
|
children: [],
|
||||||
|
tree,
|
||||||
|
allFiles,
|
||||||
|
}
|
||||||
|
|
||||||
visit(hast, "element", (elem): void => {
|
const content = renderPage(cfg, slug, componentData, opts, externalResources)
|
||||||
let ref: string | null = null
|
return write({
|
||||||
|
ctx,
|
||||||
if (
|
content,
|
||||||
["script", "img", "audio", "video", "source", "iframe"].includes(elem.tagName) &&
|
slug,
|
||||||
elem?.properties?.src
|
ext: ".html",
|
||||||
) {
|
|
||||||
ref = elem.properties.src.toString()
|
|
||||||
} else if (["a", "link"].includes(elem.tagName) && elem?.properties?.href) {
|
|
||||||
// transclusions will create a tags with relative hrefs
|
|
||||||
ref = elem.properties.href.toString()
|
|
||||||
}
|
|
||||||
|
|
||||||
// if it is a relative url, its a local file and we need to add
|
|
||||||
// it to the dependency graph. otherwise, ignore
|
|
||||||
if (ref === null || !isRelativeURL(ref)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
let fp = path.join(file.data.filePath!, path.relative(argv.directory, ref)).replace(/\\/g, "/")
|
|
||||||
// markdown files have the .md extension stripped in hrefs, add it back here
|
|
||||||
if (!fp.split("/").pop()?.includes(".")) {
|
|
||||||
fp += ".md"
|
|
||||||
}
|
|
||||||
dependencies.push(fp)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
return dependencies
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
|
export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
|
||||||
@@ -79,64 +73,48 @@ export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOp
|
|||||||
Footer,
|
Footer,
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
async getDependencyGraph(ctx, content, _resources) {
|
async *emit(ctx, content, resources) {
|
||||||
const graph = new DepGraph<FilePath>()
|
|
||||||
|
|
||||||
for (const [tree, file] of content) {
|
|
||||||
const sourcePath = file.data.filePath!
|
|
||||||
const slug = file.data.slug!
|
|
||||||
graph.addEdge(sourcePath, joinSegments(ctx.argv.output, slug + ".html") as FilePath)
|
|
||||||
|
|
||||||
parseDependencies(ctx.argv, tree as Root, file).forEach((dep) => {
|
|
||||||
graph.addEdge(dep as FilePath, sourcePath)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
|
||||||
async emit(ctx, content, resources): Promise<FilePath[]> {
|
|
||||||
const cfg = ctx.cfg.configuration
|
|
||||||
const fps: FilePath[] = []
|
|
||||||
const allFiles = content.map((c) => c[1].data)
|
const allFiles = content.map((c) => c[1].data)
|
||||||
|
|
||||||
let containsIndex = false
|
let containsIndex = false
|
||||||
|
|
||||||
for (const [tree, file] of content) {
|
for (const [tree, file] of content) {
|
||||||
const slug = file.data.slug!
|
const slug = file.data.slug!
|
||||||
if (slug === "index") {
|
if (slug === "index") {
|
||||||
containsIndex = true
|
containsIndex = true
|
||||||
}
|
}
|
||||||
|
|
||||||
const externalResources = pageResources(pathToRoot(slug), file.data, resources)
|
// only process home page, non-tag pages, and non-index pages
|
||||||
const componentData: QuartzComponentProps = {
|
if (slug.endsWith("/index") || slug.startsWith("tags/")) continue
|
||||||
ctx,
|
yield processContent(ctx, tree, file.data, allFiles, opts, resources)
|
||||||
fileData: file.data,
|
|
||||||
externalResources,
|
|
||||||
cfg,
|
|
||||||
children: [],
|
|
||||||
tree,
|
|
||||||
allFiles,
|
|
||||||
}
|
|
||||||
|
|
||||||
const content = renderPage(cfg, slug, componentData, opts, externalResources)
|
|
||||||
const fp = await write({
|
|
||||||
ctx,
|
|
||||||
content,
|
|
||||||
slug,
|
|
||||||
ext: ".html",
|
|
||||||
})
|
|
||||||
|
|
||||||
fps.push(fp)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!containsIndex && !ctx.argv.fastRebuild) {
|
if (!containsIndex) {
|
||||||
console.log(
|
console.log(
|
||||||
chalk.yellow(
|
chalk.yellow(
|
||||||
`\nWarning: you seem to be missing an \`index.md\` home page file at the root of your \`${ctx.argv.directory}\` folder (\`${path.join(ctx.argv.directory, "index.md")} does not exist\`). This may cause errors when deploying.`,
|
`\nWarning: you seem to be missing an \`index.md\` home page file at the root of your \`${ctx.argv.directory}\` folder (\`${path.join(ctx.argv.directory, "index.md")} does not exist\`). This may cause errors when deploying.`,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
async *partialEmit(ctx, content, resources, changeEvents) {
|
||||||
|
const allFiles = content.map((c) => c[1].data)
|
||||||
|
|
||||||
return fps
|
// find all slugs that changed or were added
|
||||||
|
const changedSlugs = new Set<string>()
|
||||||
|
for (const changeEvent of changeEvents) {
|
||||||
|
if (!changeEvent.file) continue
|
||||||
|
if (changeEvent.type === "add" || changeEvent.type === "change") {
|
||||||
|
changedSlugs.add(changeEvent.file.data.slug!)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const [tree, file] of content) {
|
||||||
|
const slug = file.data.slug!
|
||||||
|
if (!changedSlugs.has(slug)) continue
|
||||||
|
if (slug.endsWith("/index") || slug.startsWith("tags/")) continue
|
||||||
|
|
||||||
|
yield processContent(ctx, tree, file.data, allFiles, opts, resources)
|
||||||
|
}
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import { ProcessedContent, QuartzPluginData, defaultProcessedContent } from "../
|
|||||||
import { FullPageLayout } from "../../cfg"
|
import { FullPageLayout } from "../../cfg"
|
||||||
import path from "path"
|
import path from "path"
|
||||||
import {
|
import {
|
||||||
FilePath,
|
|
||||||
FullSlug,
|
FullSlug,
|
||||||
SimpleSlug,
|
SimpleSlug,
|
||||||
stripSlashes,
|
stripSlashes,
|
||||||
@@ -18,13 +17,89 @@ import {
|
|||||||
import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
|
import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
|
||||||
import { FolderContent } from "../../components"
|
import { FolderContent } from "../../components"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import { i18n } from "../../i18n"
|
import { i18n, TRANSLATIONS } from "../../i18n"
|
||||||
import DepGraph from "../../depgraph"
|
import { BuildCtx } from "../../util/ctx"
|
||||||
|
import { StaticResources } from "../../util/resources"
|
||||||
interface FolderPageOptions extends FullPageLayout {
|
interface FolderPageOptions extends FullPageLayout {
|
||||||
sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number
|
sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function* processFolderInfo(
|
||||||
|
ctx: BuildCtx,
|
||||||
|
folderInfo: Record<SimpleSlug, ProcessedContent>,
|
||||||
|
allFiles: QuartzPluginData[],
|
||||||
|
opts: FullPageLayout,
|
||||||
|
resources: StaticResources,
|
||||||
|
) {
|
||||||
|
for (const [folder, folderContent] of Object.entries(folderInfo) as [
|
||||||
|
SimpleSlug,
|
||||||
|
ProcessedContent,
|
||||||
|
][]) {
|
||||||
|
const slug = joinSegments(folder, "index") as FullSlug
|
||||||
|
const [tree, file] = folderContent
|
||||||
|
const cfg = ctx.cfg.configuration
|
||||||
|
const externalResources = pageResources(pathToRoot(slug), resources)
|
||||||
|
const componentData: QuartzComponentProps = {
|
||||||
|
ctx,
|
||||||
|
fileData: file.data,
|
||||||
|
externalResources,
|
||||||
|
cfg,
|
||||||
|
children: [],
|
||||||
|
tree,
|
||||||
|
allFiles,
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = renderPage(cfg, slug, componentData, opts, externalResources)
|
||||||
|
yield write({
|
||||||
|
ctx,
|
||||||
|
content,
|
||||||
|
slug,
|
||||||
|
ext: ".html",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function computeFolderInfo(
|
||||||
|
folders: Set<SimpleSlug>,
|
||||||
|
content: ProcessedContent[],
|
||||||
|
locale: keyof typeof TRANSLATIONS,
|
||||||
|
): Record<SimpleSlug, ProcessedContent> {
|
||||||
|
// Create default folder descriptions
|
||||||
|
const folderInfo: Record<SimpleSlug, ProcessedContent> = Object.fromEntries(
|
||||||
|
[...folders].map((folder) => [
|
||||||
|
folder,
|
||||||
|
defaultProcessedContent({
|
||||||
|
slug: joinSegments(folder, "index") as FullSlug,
|
||||||
|
frontmatter: {
|
||||||
|
title: `${i18n(locale).pages.folderContent.folder}: ${folder}`,
|
||||||
|
tags: [],
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
]),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Update with actual content if available
|
||||||
|
for (const [tree, file] of content) {
|
||||||
|
const slug = stripSlashes(simplifySlug(file.data.slug!)) as SimpleSlug
|
||||||
|
if (folders.has(slug)) {
|
||||||
|
folderInfo[slug] = [tree, file]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return folderInfo
|
||||||
|
}
|
||||||
|
|
||||||
|
function _getFolders(slug: FullSlug): SimpleSlug[] {
|
||||||
|
var folderName = path.dirname(slug ?? "") as SimpleSlug
|
||||||
|
const parentFolderNames = [folderName]
|
||||||
|
|
||||||
|
while (folderName !== ".") {
|
||||||
|
folderName = path.dirname(folderName ?? "") as SimpleSlug
|
||||||
|
parentFolderNames.push(folderName)
|
||||||
|
}
|
||||||
|
return parentFolderNames
|
||||||
|
}
|
||||||
|
|
||||||
export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (userOpts) => {
|
export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (userOpts) => {
|
||||||
const opts: FullPageLayout = {
|
const opts: FullPageLayout = {
|
||||||
...sharedPageComponents,
|
...sharedPageComponents,
|
||||||
@@ -53,24 +128,7 @@ export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (user
|
|||||||
Footer,
|
Footer,
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
async getDependencyGraph(_ctx, content, _resources) {
|
async *emit(ctx, content, resources) {
|
||||||
// Example graph:
|
|
||||||
// nested/file.md --> nested/index.html
|
|
||||||
// nested/file2.md ------^
|
|
||||||
const graph = new DepGraph<FilePath>()
|
|
||||||
|
|
||||||
content.map(([_tree, vfile]) => {
|
|
||||||
const slug = vfile.data.slug
|
|
||||||
const folderName = path.dirname(slug ?? "") as SimpleSlug
|
|
||||||
if (slug && folderName !== "." && folderName !== "tags") {
|
|
||||||
graph.addEdge(vfile.data.filePath!, joinSegments(folderName, "index.html") as FilePath)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
|
||||||
async emit(ctx, content, resources): Promise<FilePath[]> {
|
|
||||||
const fps: FilePath[] = []
|
|
||||||
const allFiles = content.map((c) => c[1].data)
|
const allFiles = content.map((c) => c[1].data)
|
||||||
const cfg = ctx.cfg.configuration
|
const cfg = ctx.cfg.configuration
|
||||||
|
|
||||||
@@ -84,62 +142,29 @@ export const FolderPage: QuartzEmitterPlugin<Partial<FolderPageOptions>> = (user
|
|||||||
}),
|
}),
|
||||||
)
|
)
|
||||||
|
|
||||||
const folderDescriptions: Record<string, ProcessedContent> = Object.fromEntries(
|
const folderInfo = computeFolderInfo(folders, content, cfg.locale)
|
||||||
[...folders].map((folder) => [
|
yield* processFolderInfo(ctx, folderInfo, allFiles, opts, resources)
|
||||||
folder,
|
},
|
||||||
defaultProcessedContent({
|
async *partialEmit(ctx, content, resources, changeEvents) {
|
||||||
slug: joinSegments(folder, "index") as FullSlug,
|
const allFiles = content.map((c) => c[1].data)
|
||||||
frontmatter: {
|
const cfg = ctx.cfg.configuration
|
||||||
title: `${i18n(cfg.locale).pages.folderContent.folder}: ${folder}`,
|
|
||||||
tags: [],
|
|
||||||
},
|
|
||||||
}),
|
|
||||||
]),
|
|
||||||
)
|
|
||||||
|
|
||||||
for (const [tree, file] of content) {
|
// Find all folders that need to be updated based on changed files
|
||||||
const slug = stripSlashes(simplifySlug(file.data.slug!)) as SimpleSlug
|
const affectedFolders: Set<SimpleSlug> = new Set()
|
||||||
if (folders.has(slug)) {
|
for (const changeEvent of changeEvents) {
|
||||||
folderDescriptions[slug] = [tree, file]
|
if (!changeEvent.file) continue
|
||||||
}
|
const slug = changeEvent.file.data.slug!
|
||||||
|
const folders = _getFolders(slug).filter(
|
||||||
|
(folderName) => folderName !== "." && folderName !== "tags",
|
||||||
|
)
|
||||||
|
folders.forEach((folder) => affectedFolders.add(folder))
|
||||||
}
|
}
|
||||||
|
|
||||||
for (const folder of folders) {
|
// If there are affected folders, rebuild their pages
|
||||||
const slug = joinSegments(folder, "index") as FullSlug
|
if (affectedFolders.size > 0) {
|
||||||
const [tree, file] = folderDescriptions[folder]
|
const folderInfo = computeFolderInfo(affectedFolders, content, cfg.locale)
|
||||||
const externalResources = pageResources(pathToRoot(slug), file.data, resources)
|
yield* processFolderInfo(ctx, folderInfo, allFiles, opts, resources)
|
||||||
const componentData: QuartzComponentProps = {
|
|
||||||
ctx,
|
|
||||||
fileData: file.data,
|
|
||||||
externalResources,
|
|
||||||
cfg,
|
|
||||||
children: [],
|
|
||||||
tree,
|
|
||||||
allFiles,
|
|
||||||
}
|
|
||||||
|
|
||||||
const content = renderPage(cfg, slug, componentData, opts, externalResources)
|
|
||||||
const fp = await write({
|
|
||||||
ctx,
|
|
||||||
content,
|
|
||||||
slug,
|
|
||||||
ext: ".html",
|
|
||||||
})
|
|
||||||
|
|
||||||
fps.push(fp)
|
|
||||||
}
|
}
|
||||||
return fps
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function _getFolders(slug: FullSlug): SimpleSlug[] {
|
|
||||||
var folderName = path.dirname(slug ?? "") as SimpleSlug
|
|
||||||
const parentFolderNames = [folderName]
|
|
||||||
|
|
||||||
while (folderName !== ".") {
|
|
||||||
folderName = path.dirname(folderName ?? "") as SimpleSlug
|
|
||||||
parentFolderNames.push(folderName)
|
|
||||||
}
|
|
||||||
return parentFolderNames
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -2,12 +2,13 @@ import path from "path"
|
|||||||
import fs from "fs"
|
import fs from "fs"
|
||||||
import { BuildCtx } from "../../util/ctx"
|
import { BuildCtx } from "../../util/ctx"
|
||||||
import { FilePath, FullSlug, joinSegments } from "../../util/path"
|
import { FilePath, FullSlug, joinSegments } from "../../util/path"
|
||||||
|
import { Readable } from "stream"
|
||||||
|
|
||||||
type WriteOptions = {
|
type WriteOptions = {
|
||||||
ctx: BuildCtx
|
ctx: BuildCtx
|
||||||
slug: FullSlug
|
slug: FullSlug
|
||||||
ext: `.${string}` | ""
|
ext: `.${string}` | ""
|
||||||
content: string | Buffer
|
content: string | Buffer | Readable
|
||||||
}
|
}
|
||||||
|
|
||||||
export const write = async ({ ctx, slug, ext, content }: WriteOptions): Promise<FilePath> => {
|
export const write = async ({ ctx, slug, ext, content }: WriteOptions): Promise<FilePath> => {
|
||||||
|
|||||||
@@ -8,3 +8,4 @@ export { Static } from "./static"
|
|||||||
export { ComponentResources } from "./componentResources"
|
export { ComponentResources } from "./componentResources"
|
||||||
export { NotFoundPage } from "./404"
|
export { NotFoundPage } from "./404"
|
||||||
export { CNAME } from "./cname"
|
export { CNAME } from "./cname"
|
||||||
|
export { CustomOgImages } from "./ogImage"
|
||||||
|
|||||||
155
quartz/plugins/emitters/ogImage.tsx
Normal file
155
quartz/plugins/emitters/ogImage.tsx
Normal file
@@ -0,0 +1,155 @@
|
|||||||
|
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, { SatoriOptions } from "satori"
|
||||||
|
import { loadEmoji, getIconCode } from "../../util/emoji"
|
||||||
|
import { Readable } from "stream"
|
||||||
|
import { write } from "./helpers"
|
||||||
|
import { BuildCtx } from "../../util/ctx"
|
||||||
|
import { QuartzPluginData } from "../vfile"
|
||||||
|
|
||||||
|
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<Readable> {
|
||||||
|
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 })
|
||||||
|
}
|
||||||
|
|
||||||
|
async function processOgImage(
|
||||||
|
ctx: BuildCtx,
|
||||||
|
fileData: QuartzPluginData,
|
||||||
|
fonts: SatoriOptions["fonts"],
|
||||||
|
fullOptions: SocialImageOptions,
|
||||||
|
) {
|
||||||
|
const cfg = ctx.cfg.configuration
|
||||||
|
const slug = fileData.slug!
|
||||||
|
const titleSuffix = cfg.pageTitleSuffix ?? ""
|
||||||
|
const title =
|
||||||
|
(fileData.frontmatter?.title ?? i18n(cfg.locale).propertyDefaults.title) + titleSuffix
|
||||||
|
const description =
|
||||||
|
fileData.frontmatter?.socialDescription ??
|
||||||
|
fileData.frontmatter?.description ??
|
||||||
|
unescapeHTML(fileData.description?.trim() ?? i18n(cfg.locale).propertyDefaults.description)
|
||||||
|
|
||||||
|
const stream = await generateSocialImage(
|
||||||
|
{
|
||||||
|
title,
|
||||||
|
description,
|
||||||
|
fonts,
|
||||||
|
cfg,
|
||||||
|
fileData,
|
||||||
|
},
|
||||||
|
fullOptions,
|
||||||
|
)
|
||||||
|
|
||||||
|
return write({
|
||||||
|
ctx,
|
||||||
|
content: stream,
|
||||||
|
slug: `${slug}-og-image` as FullSlug,
|
||||||
|
ext: ".webp",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
export const CustomOgImagesEmitterName = "CustomOgImages"
|
||||||
|
export const CustomOgImages: QuartzEmitterPlugin<Partial<SocialImageOptions>> = (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 (vfile.data.frontmatter?.socialImage !== undefined) continue
|
||||||
|
yield processOgImage(ctx, vfile.data, fonts, fullOptions)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
async *partialEmit(ctx, _content, _resources, changeEvents) {
|
||||||
|
const cfg = ctx.cfg.configuration
|
||||||
|
const headerFont = cfg.theme.typography.header
|
||||||
|
const bodyFont = cfg.theme.typography.body
|
||||||
|
const fonts = await getSatoriFonts(headerFont, bodyFont)
|
||||||
|
|
||||||
|
// find all slugs that changed or were added
|
||||||
|
for (const changeEvent of changeEvents) {
|
||||||
|
if (!changeEvent.file) continue
|
||||||
|
if (changeEvent.file.data.frontmatter?.socialImage !== undefined) continue
|
||||||
|
if (changeEvent.type === "add" || changeEvent.type === "change") {
|
||||||
|
yield processOgImage(ctx, changeEvent.file.data, fonts, fullOptions)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
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 && (
|
||||||
|
<>
|
||||||
|
<meta property="og:image:width" content={fullOptions.width.toString()} />
|
||||||
|
<meta property="og:image:height" content={fullOptions.height.toString()} />
|
||||||
|
</>
|
||||||
|
)}
|
||||||
|
|
||||||
|
<meta property="og:image" content={ogImagePath} />
|
||||||
|
<meta property="og:image:url" content={ogImagePath} />
|
||||||
|
<meta name="twitter:image" content={ogImagePath} />
|
||||||
|
<meta property="og:image:type" content={ogImageMimeType} />
|
||||||
|
</>
|
||||||
|
)
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,31 +2,22 @@ import { FilePath, QUARTZ, joinSegments } from "../../util/path"
|
|||||||
import { QuartzEmitterPlugin } from "../types"
|
import { QuartzEmitterPlugin } from "../types"
|
||||||
import fs from "fs"
|
import fs from "fs"
|
||||||
import { glob } from "../../util/glob"
|
import { glob } from "../../util/glob"
|
||||||
import DepGraph from "../../depgraph"
|
import { dirname } from "path"
|
||||||
|
|
||||||
export const Static: QuartzEmitterPlugin = () => ({
|
export const Static: QuartzEmitterPlugin = () => ({
|
||||||
name: "Static",
|
name: "Static",
|
||||||
async getDependencyGraph({ argv, cfg }, _content, _resources) {
|
async *emit({ argv, cfg }) {
|
||||||
const graph = new DepGraph<FilePath>()
|
|
||||||
|
|
||||||
const staticPath = joinSegments(QUARTZ, "static")
|
const staticPath = joinSegments(QUARTZ, "static")
|
||||||
const fps = await glob("**", staticPath, cfg.configuration.ignorePatterns)
|
const fps = await glob("**", staticPath, cfg.configuration.ignorePatterns)
|
||||||
|
const outputStaticPath = joinSegments(argv.output, "static")
|
||||||
|
await fs.promises.mkdir(outputStaticPath, { recursive: true })
|
||||||
for (const fp of fps) {
|
for (const fp of fps) {
|
||||||
graph.addEdge(
|
const src = joinSegments(staticPath, fp) as FilePath
|
||||||
joinSegments("static", fp) as FilePath,
|
const dest = joinSegments(outputStaticPath, fp) as FilePath
|
||||||
joinSegments(argv.output, "static", fp) as FilePath,
|
await fs.promises.mkdir(dirname(dest), { recursive: true })
|
||||||
)
|
await fs.promises.copyFile(src, dest)
|
||||||
|
yield dest
|
||||||
}
|
}
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
|
||||||
async emit({ argv, cfg }, _content, _resources): Promise<FilePath[]> {
|
|
||||||
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[]
|
|
||||||
},
|
},
|
||||||
|
async *partialEmit() {},
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -5,23 +5,94 @@ import BodyConstructor from "../../components/Body"
|
|||||||
import { pageResources, renderPage } from "../../components/renderPage"
|
import { pageResources, renderPage } from "../../components/renderPage"
|
||||||
import { ProcessedContent, QuartzPluginData, defaultProcessedContent } from "../vfile"
|
import { ProcessedContent, QuartzPluginData, defaultProcessedContent } from "../vfile"
|
||||||
import { FullPageLayout } from "../../cfg"
|
import { FullPageLayout } from "../../cfg"
|
||||||
import {
|
import { FullSlug, getAllSegmentPrefixes, joinSegments, pathToRoot } from "../../util/path"
|
||||||
FilePath,
|
|
||||||
FullSlug,
|
|
||||||
getAllSegmentPrefixes,
|
|
||||||
joinSegments,
|
|
||||||
pathToRoot,
|
|
||||||
} from "../../util/path"
|
|
||||||
import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
|
import { defaultListPageLayout, sharedPageComponents } from "../../../quartz.layout"
|
||||||
import { TagContent } from "../../components"
|
import { TagContent } from "../../components"
|
||||||
import { write } from "./helpers"
|
import { write } from "./helpers"
|
||||||
import { i18n } from "../../i18n"
|
import { i18n, TRANSLATIONS } from "../../i18n"
|
||||||
import DepGraph from "../../depgraph"
|
import { BuildCtx } from "../../util/ctx"
|
||||||
|
import { StaticResources } from "../../util/resources"
|
||||||
|
|
||||||
interface TagPageOptions extends FullPageLayout {
|
interface TagPageOptions extends FullPageLayout {
|
||||||
sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number
|
sort?: (f1: QuartzPluginData, f2: QuartzPluginData) => number
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function computeTagInfo(
|
||||||
|
allFiles: QuartzPluginData[],
|
||||||
|
content: ProcessedContent[],
|
||||||
|
locale: keyof typeof TRANSLATIONS,
|
||||||
|
): [Set<string>, Record<string, ProcessedContent>] {
|
||||||
|
const tags: Set<string> = new Set(
|
||||||
|
allFiles.flatMap((data) => data.frontmatter?.tags ?? []).flatMap(getAllSegmentPrefixes),
|
||||||
|
)
|
||||||
|
|
||||||
|
// add base tag
|
||||||
|
tags.add("index")
|
||||||
|
|
||||||
|
const tagDescriptions: Record<string, ProcessedContent> = Object.fromEntries(
|
||||||
|
[...tags].map((tag) => {
|
||||||
|
const title =
|
||||||
|
tag === "index"
|
||||||
|
? i18n(locale).pages.tagContent.tagIndex
|
||||||
|
: `${i18n(locale).pages.tagContent.tag}: ${tag}`
|
||||||
|
return [
|
||||||
|
tag,
|
||||||
|
defaultProcessedContent({
|
||||||
|
slug: joinSegments("tags", tag) as FullSlug,
|
||||||
|
frontmatter: { title, tags: [] },
|
||||||
|
}),
|
||||||
|
]
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
// Update with actual content if available
|
||||||
|
for (const [tree, file] of content) {
|
||||||
|
const slug = file.data.slug!
|
||||||
|
if (slug.startsWith("tags/")) {
|
||||||
|
const tag = slug.slice("tags/".length)
|
||||||
|
if (tags.has(tag)) {
|
||||||
|
tagDescriptions[tag] = [tree, file]
|
||||||
|
if (file.data.frontmatter?.title === tag) {
|
||||||
|
file.data.frontmatter.title = `${i18n(locale).pages.tagContent.tag}: ${tag}`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return [tags, tagDescriptions]
|
||||||
|
}
|
||||||
|
|
||||||
|
async function processTagPage(
|
||||||
|
ctx: BuildCtx,
|
||||||
|
tag: string,
|
||||||
|
tagContent: ProcessedContent,
|
||||||
|
allFiles: QuartzPluginData[],
|
||||||
|
opts: FullPageLayout,
|
||||||
|
resources: StaticResources,
|
||||||
|
) {
|
||||||
|
const slug = joinSegments("tags", tag) as FullSlug
|
||||||
|
const [tree, file] = tagContent
|
||||||
|
const cfg = ctx.cfg.configuration
|
||||||
|
const externalResources = pageResources(pathToRoot(slug), resources)
|
||||||
|
const componentData: QuartzComponentProps = {
|
||||||
|
ctx,
|
||||||
|
fileData: file.data,
|
||||||
|
externalResources,
|
||||||
|
cfg,
|
||||||
|
children: [],
|
||||||
|
tree,
|
||||||
|
allFiles,
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = renderPage(cfg, slug, componentData, opts, externalResources)
|
||||||
|
return write({
|
||||||
|
ctx,
|
||||||
|
content,
|
||||||
|
slug: file.data.slug!,
|
||||||
|
ext: ".html",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
export const TagPage: QuartzEmitterPlugin<Partial<TagPageOptions>> = (userOpts) => {
|
export const TagPage: QuartzEmitterPlugin<Partial<TagPageOptions>> = (userOpts) => {
|
||||||
const opts: FullPageLayout = {
|
const opts: FullPageLayout = {
|
||||||
...sharedPageComponents,
|
...sharedPageComponents,
|
||||||
@@ -50,93 +121,50 @@ export const TagPage: QuartzEmitterPlugin<Partial<TagPageOptions>> = (userOpts)
|
|||||||
Footer,
|
Footer,
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
async getDependencyGraph(ctx, content, _resources) {
|
async *emit(ctx, content, resources) {
|
||||||
const graph = new DepGraph<FilePath>()
|
const allFiles = content.map((c) => c[1].data)
|
||||||
|
const cfg = ctx.cfg.configuration
|
||||||
|
const [tags, tagDescriptions] = computeTagInfo(allFiles, content, cfg.locale)
|
||||||
|
|
||||||
for (const [_tree, file] of content) {
|
for (const tag of tags) {
|
||||||
const sourcePath = file.data.filePath!
|
yield processTagPage(ctx, tag, tagDescriptions[tag], allFiles, opts, resources)
|
||||||
const tags = (file.data.frontmatter?.tags ?? []).flatMap(getAllSegmentPrefixes)
|
|
||||||
// if the file has at least one tag, it is used in the tag index page
|
|
||||||
if (tags.length > 0) {
|
|
||||||
tags.push("index")
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const tag of tags) {
|
|
||||||
graph.addEdge(
|
|
||||||
sourcePath,
|
|
||||||
joinSegments(ctx.argv.output, "tags", tag + ".html") as FilePath,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return graph
|
|
||||||
},
|
},
|
||||||
async emit(ctx, content, resources): Promise<FilePath[]> {
|
async *partialEmit(ctx, content, resources, changeEvents) {
|
||||||
const fps: FilePath[] = []
|
|
||||||
const allFiles = content.map((c) => c[1].data)
|
const allFiles = content.map((c) => c[1].data)
|
||||||
const cfg = ctx.cfg.configuration
|
const cfg = ctx.cfg.configuration
|
||||||
|
|
||||||
const tags: Set<string> = new Set(
|
// Find all tags that need to be updated based on changed files
|
||||||
allFiles.flatMap((data) => data.frontmatter?.tags ?? []).flatMap(getAllSegmentPrefixes),
|
const affectedTags: Set<string> = new Set()
|
||||||
)
|
for (const changeEvent of changeEvents) {
|
||||||
|
if (!changeEvent.file) continue
|
||||||
|
const slug = changeEvent.file.data.slug!
|
||||||
|
|
||||||
// add base tag
|
// If it's a tag page itself that changed
|
||||||
tags.add("index")
|
|
||||||
|
|
||||||
const tagDescriptions: Record<string, ProcessedContent> = Object.fromEntries(
|
|
||||||
[...tags].map((tag) => {
|
|
||||||
const title =
|
|
||||||
tag === "index"
|
|
||||||
? i18n(cfg.locale).pages.tagContent.tagIndex
|
|
||||||
: `${i18n(cfg.locale).pages.tagContent.tag}: ${tag}`
|
|
||||||
return [
|
|
||||||
tag,
|
|
||||||
defaultProcessedContent({
|
|
||||||
slug: joinSegments("tags", tag) as FullSlug,
|
|
||||||
frontmatter: { title, tags: [] },
|
|
||||||
}),
|
|
||||||
]
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
|
|
||||||
for (const [tree, file] of content) {
|
|
||||||
const slug = file.data.slug!
|
|
||||||
if (slug.startsWith("tags/")) {
|
if (slug.startsWith("tags/")) {
|
||||||
const tag = slug.slice("tags/".length)
|
const tag = slug.slice("tags/".length)
|
||||||
if (tags.has(tag)) {
|
affectedTags.add(tag)
|
||||||
tagDescriptions[tag] = [tree, file]
|
}
|
||||||
if (file.data.frontmatter?.title === tag) {
|
|
||||||
file.data.frontmatter.title = `${i18n(cfg.locale).pages.tagContent.tag}: ${tag}`
|
// If a file with tags changed, we need to update those tag pages
|
||||||
}
|
const fileTags = changeEvent.file.data.frontmatter?.tags ?? []
|
||||||
|
fileTags.flatMap(getAllSegmentPrefixes).forEach((tag) => affectedTags.add(tag))
|
||||||
|
|
||||||
|
// Always update the index tag page if any file changes
|
||||||
|
affectedTags.add("index")
|
||||||
|
}
|
||||||
|
|
||||||
|
// If there are affected tags, rebuild their pages
|
||||||
|
if (affectedTags.size > 0) {
|
||||||
|
// We still need to compute all tags because tag pages show all tags
|
||||||
|
const [_tags, tagDescriptions] = computeTagInfo(allFiles, content, cfg.locale)
|
||||||
|
|
||||||
|
for (const tag of affectedTags) {
|
||||||
|
if (tagDescriptions[tag]) {
|
||||||
|
yield processTagPage(ctx, tag, tagDescriptions[tag], allFiles, opts, resources)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
for (const tag of tags) {
|
|
||||||
const slug = joinSegments("tags", tag) as FullSlug
|
|
||||||
const [tree, file] = tagDescriptions[tag]
|
|
||||||
const externalResources = pageResources(pathToRoot(slug), file.data, resources)
|
|
||||||
const componentData: QuartzComponentProps = {
|
|
||||||
ctx,
|
|
||||||
fileData: file.data,
|
|
||||||
externalResources,
|
|
||||||
cfg,
|
|
||||||
children: [],
|
|
||||||
tree,
|
|
||||||
allFiles,
|
|
||||||
}
|
|
||||||
|
|
||||||
const content = renderPage(cfg, slug, componentData, opts, externalResources)
|
|
||||||
const fp = await write({
|
|
||||||
ctx,
|
|
||||||
content,
|
|
||||||
slug: file.data.slug!,
|
|
||||||
ext: ".html",
|
|
||||||
})
|
|
||||||
|
|
||||||
fps.push(fp)
|
|
||||||
}
|
|
||||||
return fps
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,11 +5,13 @@ import { escapeHTML } from "../../util/escape"
|
|||||||
|
|
||||||
export interface Options {
|
export interface Options {
|
||||||
descriptionLength: number
|
descriptionLength: number
|
||||||
|
maxDescriptionLength: number
|
||||||
replaceExternalLinks: boolean
|
replaceExternalLinks: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
const defaultOptions: Options = {
|
const defaultOptions: Options = {
|
||||||
descriptionLength: 150,
|
descriptionLength: 150,
|
||||||
|
maxDescriptionLength: 300,
|
||||||
replaceExternalLinks: true,
|
replaceExternalLinks: true,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -37,35 +39,41 @@ export const Description: QuartzTransformerPlugin<Partial<Options>> = (userOpts)
|
|||||||
text = text.replace(urlRegex, "$<domain>" + "$<path>")
|
text = text.replace(urlRegex, "$<domain>" + "$<path>")
|
||||||
}
|
}
|
||||||
|
|
||||||
const desc = frontMatterDescription ?? text
|
if (frontMatterDescription) {
|
||||||
const sentences = desc.replace(/\s+/g, " ").split(/\.\s/)
|
file.data.description = frontMatterDescription
|
||||||
const finalDesc: string[] = []
|
file.data.text = text
|
||||||
const len = opts.descriptionLength
|
return
|
||||||
let sentenceIdx = 0
|
}
|
||||||
let currentDescriptionLength = 0
|
|
||||||
|
|
||||||
if (sentences[0] !== undefined && sentences[0].length >= len) {
|
// otherwise, use the text content
|
||||||
const firstSentence = sentences[0].split(" ")
|
const desc = text
|
||||||
while (currentDescriptionLength < len) {
|
const sentences = desc.replace(/\s+/g, " ").split(/\.\s/)
|
||||||
const sentence = firstSentence[sentenceIdx]
|
let finalDesc = ""
|
||||||
if (!sentence) break
|
let sentenceIdx = 0
|
||||||
finalDesc.push(sentence)
|
|
||||||
currentDescriptionLength += sentence.length
|
// Add full sentences until we exceed the guideline length
|
||||||
sentenceIdx++
|
while (sentenceIdx < sentences.length) {
|
||||||
}
|
const sentence = sentences[sentenceIdx]
|
||||||
finalDesc.push("...")
|
if (!sentence) break
|
||||||
} else {
|
|
||||||
while (currentDescriptionLength < len) {
|
const currentSentence = sentence.endsWith(".") ? sentence : sentence + "."
|
||||||
const sentence = sentences[sentenceIdx]
|
const nextLength = finalDesc.length + currentSentence.length + (finalDesc ? 1 : 0)
|
||||||
if (!sentence) break
|
|
||||||
const currentSentence = sentence.endsWith(".") ? sentence : sentence + "."
|
// Add the sentence if we're under the guideline length
|
||||||
finalDesc.push(currentSentence)
|
// or if this is the first sentence (always include at least one)
|
||||||
currentDescriptionLength += currentSentence.length
|
if (nextLength <= opts.descriptionLength || sentenceIdx === 0) {
|
||||||
|
finalDesc += (finalDesc ? " " : "") + currentSentence
|
||||||
sentenceIdx++
|
sentenceIdx++
|
||||||
|
} else {
|
||||||
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
file.data.description = finalDesc.join(" ")
|
// truncate to max length if necessary
|
||||||
|
file.data.description =
|
||||||
|
finalDesc.length > opts.maxDescriptionLength
|
||||||
|
? finalDesc.slice(0, opts.maxDescriptionLength) + "..."
|
||||||
|
: finalDesc
|
||||||
file.data.text = text
|
file.data.text = text
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -3,12 +3,9 @@ import remarkFrontmatter from "remark-frontmatter"
|
|||||||
import { QuartzTransformerPlugin } from "../types"
|
import { QuartzTransformerPlugin } from "../types"
|
||||||
import yaml from "js-yaml"
|
import yaml from "js-yaml"
|
||||||
import toml from "toml"
|
import toml from "toml"
|
||||||
import { FilePath, FullSlug, joinSegments, slugifyFilePath, slugTag } from "../../util/path"
|
import { FilePath, FullSlug, getFileExtension, slugifyFilePath, slugTag } from "../../util/path"
|
||||||
import { QuartzPluginData } from "../vfile"
|
import { QuartzPluginData } from "../vfile"
|
||||||
import { i18n } from "../../i18n"
|
import { i18n } from "../../i18n"
|
||||||
import { Argv } from "../../util/ctx"
|
|
||||||
import { VFile } from "vfile"
|
|
||||||
import path from "path"
|
|
||||||
|
|
||||||
export interface Options {
|
export interface Options {
|
||||||
delimiters: string | [string, string]
|
delimiters: string | [string, string]
|
||||||
@@ -43,26 +40,24 @@ function coerceToArray(input: string | string[]): string[] | undefined {
|
|||||||
.map((tag: string | number) => tag.toString())
|
.map((tag: string | number) => tag.toString())
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getAliasSlugs(aliases: string[], argv: Argv, file: VFile): FullSlug[] {
|
function getAliasSlugs(aliases: string[]): FullSlug[] {
|
||||||
const dir = path.posix.relative(argv.directory, path.dirname(file.data.filePath!))
|
const res: FullSlug[] = []
|
||||||
const slugs: FullSlug[] = aliases.map(
|
for (const alias of aliases) {
|
||||||
(alias) => path.posix.join(dir, slugifyFilePath(alias as FilePath)) as FullSlug,
|
const isMd = getFileExtension(alias) === "md"
|
||||||
)
|
const mockFp = isMd ? alias : alias + ".md"
|
||||||
const permalink = file.data.frontmatter?.permalink
|
const slug = slugifyFilePath(mockFp as FilePath)
|
||||||
if (typeof permalink === "string") {
|
res.push(slug)
|
||||||
slugs.push(permalink as FullSlug)
|
|
||||||
}
|
}
|
||||||
// fix any slugs that have trailing slash
|
|
||||||
return slugs.map((slug) =>
|
return res
|
||||||
slug.endsWith("/") ? (joinSegments(slug, "index") as FullSlug) : slug,
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
|
export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
|
||||||
const opts = { ...defaultOptions, ...userOpts }
|
const opts = { ...defaultOptions, ...userOpts }
|
||||||
return {
|
return {
|
||||||
name: "FrontMatter",
|
name: "FrontMatter",
|
||||||
markdownPlugins({ cfg, allSlugs, argv }) {
|
markdownPlugins(ctx) {
|
||||||
|
const { cfg, allSlugs } = ctx
|
||||||
return [
|
return [
|
||||||
[remarkFrontmatter, ["yaml", "toml"]],
|
[remarkFrontmatter, ["yaml", "toml"]],
|
||||||
() => {
|
() => {
|
||||||
@@ -88,9 +83,18 @@ export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts)
|
|||||||
const aliases = coerceToArray(coalesceAliases(data, ["aliases", "alias"]))
|
const aliases = coerceToArray(coalesceAliases(data, ["aliases", "alias"]))
|
||||||
if (aliases) {
|
if (aliases) {
|
||||||
data.aliases = aliases // frontmatter
|
data.aliases = aliases // frontmatter
|
||||||
const slugs = (file.data.aliases = getAliasSlugs(aliases, argv, file))
|
file.data.aliases = getAliasSlugs(aliases)
|
||||||
allSlugs.push(...slugs)
|
allSlugs.push(...file.data.aliases)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (data.permalink != null && data.permalink.toString() !== "") {
|
||||||
|
data.permalink = data.permalink.toString() as FullSlug
|
||||||
|
const aliases = file.data.aliases ?? []
|
||||||
|
aliases.push(data.permalink)
|
||||||
|
file.data.aliases = aliases
|
||||||
|
allSlugs.push(data.permalink)
|
||||||
|
}
|
||||||
|
|
||||||
const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
|
const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
|
||||||
if (cssclasses) data.cssclasses = cssclasses
|
if (cssclasses) data.cssclasses = cssclasses
|
||||||
|
|
||||||
@@ -131,6 +135,7 @@ declare module "vfile" {
|
|||||||
created: string
|
created: string
|
||||||
published: string
|
published: string
|
||||||
description: string
|
description: string
|
||||||
|
socialDescription: string
|
||||||
publish: boolean | string
|
publish: boolean | string
|
||||||
draft: boolean | string
|
draft: boolean | string
|
||||||
lang: string
|
lang: string
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options>> = (u
|
|||||||
const opts = { ...defaultOptions, ...userOpts }
|
const opts = { ...defaultOptions, ...userOpts }
|
||||||
return {
|
return {
|
||||||
name: "CreatedModifiedDate",
|
name: "CreatedModifiedDate",
|
||||||
markdownPlugins() {
|
markdownPlugins(ctx) {
|
||||||
return [
|
return [
|
||||||
() => {
|
() => {
|
||||||
let repo: Repository | undefined = undefined
|
let repo: Repository | undefined = undefined
|
||||||
@@ -40,8 +40,8 @@ export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options>> = (u
|
|||||||
let modified: MaybeDate = undefined
|
let modified: MaybeDate = undefined
|
||||||
let published: MaybeDate = undefined
|
let published: MaybeDate = undefined
|
||||||
|
|
||||||
const fp = file.data.filePath!
|
const fp = file.data.relativePath!
|
||||||
const fullFp = path.isAbsolute(fp) ? fp : path.posix.join(file.cwd, fp)
|
const fullFp = path.posix.join(ctx.argv.directory, fp)
|
||||||
for (const source of opts.priority) {
|
for (const source of opts.priority) {
|
||||||
if (source === "filesystem") {
|
if (source === "filesystem") {
|
||||||
const st = await fs.promises.stat(fullFp)
|
const st = await fs.promises.stat(fullFp)
|
||||||
@@ -56,11 +56,11 @@ export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options>> = (u
|
|||||||
// Get a reference to the main git repo.
|
// Get a reference to the main git repo.
|
||||||
// It's either the same as the workdir,
|
// It's either the same as the workdir,
|
||||||
// or 1+ level higher in case of a submodule/subtree setup
|
// or 1+ level higher in case of a submodule/subtree setup
|
||||||
repo = Repository.discover(file.cwd)
|
repo = Repository.discover(ctx.argv.directory)
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
modified ||= await repo.getFileLatestModifiedDateAsync(file.data.filePath!)
|
modified ||= await repo.getFileLatestModifiedDateAsync(fullFp)
|
||||||
} catch {
|
} catch {
|
||||||
console.log(
|
console.log(
|
||||||
chalk.yellow(
|
chalk.yellow(
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ export const OxHugoFlavouredMarkdown: QuartzTransformerPlugin<Partial<Options>>
|
|||||||
textTransform(_ctx, src) {
|
textTransform(_ctx, src) {
|
||||||
if (opts.wikilinks) {
|
if (opts.wikilinks) {
|
||||||
src = src.toString()
|
src = src.toString()
|
||||||
src = src.replaceAll(relrefRegex, (value, ...capture) => {
|
src = src.replaceAll(relrefRegex, (_value, ...capture) => {
|
||||||
const [text, link] = capture
|
const [text, link] = capture
|
||||||
return `[${text}](${link})`
|
return `[${text}](${link})`
|
||||||
})
|
})
|
||||||
@@ -62,7 +62,7 @@ export const OxHugoFlavouredMarkdown: QuartzTransformerPlugin<Partial<Options>>
|
|||||||
|
|
||||||
if (opts.removePredefinedAnchor) {
|
if (opts.removePredefinedAnchor) {
|
||||||
src = src.toString()
|
src = src.toString()
|
||||||
src = src.replaceAll(predefinedHeadingIdRegex, (value, ...capture) => {
|
src = src.replaceAll(predefinedHeadingIdRegex, (_value, ...capture) => {
|
||||||
const [headingText] = capture
|
const [headingText] = capture
|
||||||
return headingText
|
return headingText
|
||||||
})
|
})
|
||||||
@@ -70,7 +70,7 @@ export const OxHugoFlavouredMarkdown: QuartzTransformerPlugin<Partial<Options>>
|
|||||||
|
|
||||||
if (opts.removeHugoShortcode) {
|
if (opts.removeHugoShortcode) {
|
||||||
src = src.toString()
|
src = src.toString()
|
||||||
src = src.replaceAll(hugoShortcodeRegex, (value, ...capture) => {
|
src = src.replaceAll(hugoShortcodeRegex, (_value, ...capture) => {
|
||||||
const [scContent] = capture
|
const [scContent] = capture
|
||||||
return scContent
|
return scContent
|
||||||
})
|
})
|
||||||
@@ -78,7 +78,7 @@ export const OxHugoFlavouredMarkdown: QuartzTransformerPlugin<Partial<Options>>
|
|||||||
|
|
||||||
if (opts.replaceFigureWithMdImg) {
|
if (opts.replaceFigureWithMdImg) {
|
||||||
src = src.toString()
|
src = src.toString()
|
||||||
src = src.replaceAll(figureTagRegex, (value, ...capture) => {
|
src = src.replaceAll(figureTagRegex, (_value, ...capture) => {
|
||||||
const [src] = capture
|
const [src] = capture
|
||||||
return ``
|
return ``
|
||||||
})
|
})
|
||||||
@@ -86,11 +86,11 @@ export const OxHugoFlavouredMarkdown: QuartzTransformerPlugin<Partial<Options>>
|
|||||||
|
|
||||||
if (opts.replaceOrgLatex) {
|
if (opts.replaceOrgLatex) {
|
||||||
src = src.toString()
|
src = src.toString()
|
||||||
src = src.replaceAll(inlineLatexRegex, (value, ...capture) => {
|
src = src.replaceAll(inlineLatexRegex, (_value, ...capture) => {
|
||||||
const [eqn] = capture
|
const [eqn] = capture
|
||||||
return `$${eqn}$`
|
return `$${eqn}$`
|
||||||
})
|
})
|
||||||
src = src.replaceAll(blockLatexRegex, (value, ...capture) => {
|
src = src.replaceAll(blockLatexRegex, (_value, ...capture) => {
|
||||||
const [eqn] = capture
|
const [eqn] = capture
|
||||||
return `$$${eqn}$$`
|
return `$$${eqn}$$`
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1,10 +1,8 @@
|
|||||||
import { QuartzTransformerPlugin } from "../types"
|
import { QuartzTransformerPlugin } from "../types"
|
||||||
import { PluggableList } from "unified"
|
import { PluggableList } from "unified"
|
||||||
import { SKIP, visit } from "unist-util-visit"
|
import { visit } from "unist-util-visit"
|
||||||
import { ReplaceFunction, findAndReplace as mdastFindReplace } from "mdast-util-find-and-replace"
|
import { ReplaceFunction, findAndReplace as mdastFindReplace } from "mdast-util-find-and-replace"
|
||||||
import { Root, Html, Paragraph, Text, Link, Parent } from "mdast"
|
import { Root, Html, Paragraph, Text, Link, Parent } from "mdast"
|
||||||
import { Node } from "unist"
|
|
||||||
import { VFile } from "vfile"
|
|
||||||
import { BuildVisitor } from "unist-util-visit"
|
import { BuildVisitor } from "unist-util-visit"
|
||||||
|
|
||||||
export interface Options {
|
export interface Options {
|
||||||
@@ -34,21 +32,10 @@ const defaultOptions: Options = {
|
|||||||
const orRegex = new RegExp(/{{or:(.*?)}}/, "g")
|
const orRegex = new RegExp(/{{or:(.*?)}}/, "g")
|
||||||
const TODORegex = new RegExp(/{{.*?\bTODO\b.*?}}/, "g")
|
const TODORegex = new RegExp(/{{.*?\bTODO\b.*?}}/, "g")
|
||||||
const DONERegex = new RegExp(/{{.*?\bDONE\b.*?}}/, "g")
|
const DONERegex = new RegExp(/{{.*?\bDONE\b.*?}}/, "g")
|
||||||
const videoRegex = new RegExp(/{{.*?\[\[video\]\].*?\:(.*?)}}/, "g")
|
|
||||||
const youtubeRegex = new RegExp(
|
|
||||||
/{{.*?\[\[video\]\].*?(https?:\/\/(?:www\.)?youtu(?:be\.com\/watch\?v=|\.be\/)([\w\-\_]*)(&(amp;)?[\w\?=]*)?)}}/,
|
|
||||||
"g",
|
|
||||||
)
|
|
||||||
|
|
||||||
// const multimediaRegex = new RegExp(/{{.*?\b(video|audio)\b.*?\:(.*?)}}/, "g")
|
|
||||||
|
|
||||||
const audioRegex = new RegExp(/{{.*?\[\[audio\]\].*?\:(.*?)}}/, "g")
|
|
||||||
const pdfRegex = new RegExp(/{{.*?\[\[pdf\]\].*?\:(.*?)}}/, "g")
|
|
||||||
const blockquoteRegex = new RegExp(/(\[\[>\]\])\s*(.*)/, "g")
|
const blockquoteRegex = new RegExp(/(\[\[>\]\])\s*(.*)/, "g")
|
||||||
const roamHighlightRegex = new RegExp(/\^\^(.+)\^\^/, "g")
|
const roamHighlightRegex = new RegExp(/\^\^(.+)\^\^/, "g")
|
||||||
const roamItalicRegex = new RegExp(/__(.+)__/, "g")
|
const roamItalicRegex = new RegExp(/__(.+)__/, "g")
|
||||||
const tableRegex = new RegExp(/- {{.*?\btable\b.*?}}/, "g") /* TODO */
|
|
||||||
const attributeRegex = new RegExp(/\b\w+(?:\s+\w+)*::/, "g") /* TODO */
|
|
||||||
|
|
||||||
function isSpecialEmbed(node: Paragraph): boolean {
|
function isSpecialEmbed(node: Paragraph): boolean {
|
||||||
if (node.children.length !== 2) return false
|
if (node.children.length !== 2) return false
|
||||||
@@ -135,7 +122,7 @@ export const RoamFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | un
|
|||||||
const plugins: PluggableList = []
|
const plugins: PluggableList = []
|
||||||
|
|
||||||
plugins.push(() => {
|
plugins.push(() => {
|
||||||
return (tree: Root, file: VFile) => {
|
return (tree: Root) => {
|
||||||
const replacements: [RegExp, ReplaceFunction][] = []
|
const replacements: [RegExp, ReplaceFunction][] = []
|
||||||
|
|
||||||
// Handle special embeds (audio, video, PDF)
|
// Handle special embeds (audio, video, PDF)
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import { ProcessedContent } from "./vfile"
|
|||||||
import { QuartzComponent } from "../components/types"
|
import { QuartzComponent } from "../components/types"
|
||||||
import { FilePath } from "../util/path"
|
import { FilePath } from "../util/path"
|
||||||
import { BuildCtx } from "../util/ctx"
|
import { BuildCtx } from "../util/ctx"
|
||||||
import DepGraph from "../depgraph"
|
import { VFile } from "vfile"
|
||||||
|
|
||||||
export interface PluginTypes {
|
export interface PluginTypes {
|
||||||
transformers: QuartzTransformerPluginInstance[]
|
transformers: QuartzTransformerPluginInstance[]
|
||||||
@@ -33,22 +33,33 @@ export type QuartzFilterPluginInstance = {
|
|||||||
shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean
|
shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type ChangeEvent = {
|
||||||
|
type: "add" | "change" | "delete"
|
||||||
|
path: FilePath
|
||||||
|
file?: VFile
|
||||||
|
}
|
||||||
|
|
||||||
export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
|
export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
|
||||||
opts?: Options,
|
opts?: Options,
|
||||||
) => QuartzEmitterPluginInstance
|
) => QuartzEmitterPluginInstance
|
||||||
export type QuartzEmitterPluginInstance = {
|
export type QuartzEmitterPluginInstance = {
|
||||||
name: string
|
name: string
|
||||||
emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
|
emit: (
|
||||||
|
ctx: BuildCtx,
|
||||||
|
content: ProcessedContent[],
|
||||||
|
resources: StaticResources,
|
||||||
|
) => Promise<FilePath[]> | AsyncGenerator<FilePath>
|
||||||
|
partialEmit?: (
|
||||||
|
ctx: BuildCtx,
|
||||||
|
content: ProcessedContent[],
|
||||||
|
resources: StaticResources,
|
||||||
|
changeEvents: ChangeEvent[],
|
||||||
|
) => Promise<FilePath[]> | AsyncGenerator<FilePath> | null
|
||||||
/**
|
/**
|
||||||
* Returns the components (if any) that are used in rendering the page.
|
* Returns the components (if any) that are used in rendering the page.
|
||||||
* This helps Quartz optimize the page by only including necessary resources
|
* This helps Quartz optimize the page by only including necessary resources
|
||||||
* for components that are actually used.
|
* for components that are actually used.
|
||||||
*/
|
*/
|
||||||
getQuartzComponents?: (ctx: BuildCtx) => QuartzComponent[]
|
getQuartzComponents?: (ctx: BuildCtx) => QuartzComponent[]
|
||||||
getDependencyGraph?(
|
|
||||||
ctx: BuildCtx,
|
|
||||||
content: ProcessedContent[],
|
|
||||||
resources: StaticResources,
|
|
||||||
): Promise<DepGraph<FilePath>>
|
|
||||||
externalResources?: ExternalResourcesFn
|
externalResources?: ExternalResourcesFn
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,30 +4,47 @@ import { ProcessedContent } from "../plugins/vfile"
|
|||||||
import { QuartzLogger } from "../util/log"
|
import { QuartzLogger } from "../util/log"
|
||||||
import { trace } from "../util/trace"
|
import { trace } from "../util/trace"
|
||||||
import { BuildCtx } from "../util/ctx"
|
import { BuildCtx } from "../util/ctx"
|
||||||
|
import chalk from "chalk"
|
||||||
|
|
||||||
export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) {
|
export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) {
|
||||||
const { argv, cfg } = ctx
|
const { argv, cfg } = ctx
|
||||||
const perf = new PerfTimer()
|
const perf = new PerfTimer()
|
||||||
const log = new QuartzLogger(ctx.argv.verbose)
|
const log = new QuartzLogger(ctx.argv.verbose)
|
||||||
|
|
||||||
log.start(`Emitting output files`)
|
log.start(`Emitting files`)
|
||||||
|
|
||||||
let emittedFiles = 0
|
let emittedFiles = 0
|
||||||
const staticResources = getStaticResourcesFromPlugins(ctx)
|
const staticResources = getStaticResourcesFromPlugins(ctx)
|
||||||
for (const emitter of cfg.plugins.emitters) {
|
await Promise.all(
|
||||||
try {
|
cfg.plugins.emitters.map(async (emitter) => {
|
||||||
const emitted = await emitter.emit(ctx, content, staticResources)
|
try {
|
||||||
emittedFiles += emitted.length
|
const emitted = await emitter.emit(ctx, content, staticResources)
|
||||||
|
if (Symbol.asyncIterator in emitted) {
|
||||||
if (ctx.argv.verbose) {
|
// Async generator case
|
||||||
for (const file of emitted) {
|
for await (const file of emitted) {
|
||||||
console.log(`[emit:${emitter.name}] ${file}`)
|
emittedFiles++
|
||||||
|
if (ctx.argv.verbose) {
|
||||||
|
console.log(`[emit:${emitter.name}] ${file}`)
|
||||||
|
} else {
|
||||||
|
log.updateText(`${emitter.name} -> ${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(`${emitter.name} -> ${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()}`)
|
log.end(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince()}`)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,12 +7,13 @@ import { Root as HTMLRoot } from "hast"
|
|||||||
import { MarkdownContent, ProcessedContent } from "../plugins/vfile"
|
import { MarkdownContent, ProcessedContent } from "../plugins/vfile"
|
||||||
import { PerfTimer } from "../util/perf"
|
import { PerfTimer } from "../util/perf"
|
||||||
import { read } from "to-vfile"
|
import { read } from "to-vfile"
|
||||||
import { FilePath, FullSlug, QUARTZ, slugifyFilePath } from "../util/path"
|
import { FilePath, QUARTZ, slugifyFilePath } from "../util/path"
|
||||||
import path from "path"
|
import path from "path"
|
||||||
import workerpool, { Promise as WorkerPromise } from "workerpool"
|
import workerpool, { Promise as WorkerPromise } from "workerpool"
|
||||||
import { QuartzLogger } from "../util/log"
|
import { QuartzLogger } from "../util/log"
|
||||||
import { trace } from "../util/trace"
|
import { trace } from "../util/trace"
|
||||||
import { BuildCtx } from "../util/ctx"
|
import { BuildCtx, WorkerSerializableBuildCtx } from "../util/ctx"
|
||||||
|
import chalk from "chalk"
|
||||||
|
|
||||||
export type QuartzMdProcessor = Processor<MDRoot, MDRoot, MDRoot>
|
export type QuartzMdProcessor = Processor<MDRoot, MDRoot, MDRoot>
|
||||||
export type QuartzHtmlProcessor = Processor<undefined, MDRoot, HTMLRoot>
|
export type QuartzHtmlProcessor = Processor<undefined, MDRoot, HTMLRoot>
|
||||||
@@ -175,21 +176,42 @@ export async function parseMarkdown(ctx: BuildCtx, fps: FilePath[]): Promise<Pro
|
|||||||
process.exit(1)
|
process.exit(1)
|
||||||
}
|
}
|
||||||
|
|
||||||
const mdPromises: WorkerPromise<[MarkdownContent[], FullSlug[]]>[] = []
|
const serializableCtx: WorkerSerializableBuildCtx = {
|
||||||
for (const chunk of chunks(fps, CHUNK_SIZE)) {
|
buildId: ctx.buildId,
|
||||||
mdPromises.push(pool.exec("parseMarkdown", [ctx.buildId, argv, chunk]))
|
argv: ctx.argv,
|
||||||
|
allSlugs: ctx.allSlugs,
|
||||||
|
allFiles: ctx.allFiles,
|
||||||
|
incremental: ctx.incremental,
|
||||||
}
|
}
|
||||||
const mdResults: [MarkdownContent[], FullSlug[]][] =
|
|
||||||
await WorkerPromise.all(mdPromises).catch(errorHandler)
|
|
||||||
|
|
||||||
const childPromises: WorkerPromise<ProcessedContent[]>[] = []
|
const textToMarkdownPromises: WorkerPromise<MarkdownContent[]>[] = []
|
||||||
for (const [_, extraSlugs] of mdResults) {
|
let processedFiles = 0
|
||||||
ctx.allSlugs.push(...extraSlugs)
|
for (const chunk of chunks(fps, CHUNK_SIZE)) {
|
||||||
|
textToMarkdownPromises.push(pool.exec("parseMarkdown", [serializableCtx, chunk]))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const mdResults: Array<MarkdownContent[]> = await Promise.all(
|
||||||
|
textToMarkdownPromises.map(async (promise) => {
|
||||||
|
const result = await promise
|
||||||
|
processedFiles += result.length
|
||||||
|
log.updateText(`text->markdown ${chalk.gray(`${processedFiles}/${fps.length}`)}`)
|
||||||
|
return result
|
||||||
|
}),
|
||||||
|
).catch(errorHandler)
|
||||||
|
|
||||||
|
const markdownToHtmlPromises: WorkerPromise<ProcessedContent[]>[] = []
|
||||||
|
processedFiles = 0
|
||||||
for (const [mdChunk, _] of mdResults) {
|
for (const [mdChunk, _] of mdResults) {
|
||||||
childPromises.push(pool.exec("processHtml", [ctx.buildId, argv, mdChunk, ctx.allSlugs]))
|
markdownToHtmlPromises.push(pool.exec("processHtml", [serializableCtx, mdChunk]))
|
||||||
}
|
}
|
||||||
const results: ProcessedContent[][] = await WorkerPromise.all(childPromises).catch(errorHandler)
|
const results: ProcessedContent[][] = await Promise.all(
|
||||||
|
markdownToHtmlPromises.map(async (promise) => {
|
||||||
|
const result = await promise
|
||||||
|
processedFiles += result.length
|
||||||
|
log.updateText(`markdown->html ${chalk.gray(`${processedFiles}/${fps.length}`)}`)
|
||||||
|
return result
|
||||||
|
}),
|
||||||
|
).catch(errorHandler)
|
||||||
|
|
||||||
res = results.flat()
|
res = results.flat()
|
||||||
await pool.terminate()
|
await pool.terminate()
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
import { QuartzConfig } from "../cfg"
|
import { QuartzConfig } from "../cfg"
|
||||||
import { FullSlug } from "./path"
|
import { FilePath, FullSlug } from "./path"
|
||||||
|
|
||||||
export interface Argv {
|
export interface Argv {
|
||||||
directory: string
|
directory: string
|
||||||
verbose: boolean
|
verbose: boolean
|
||||||
output: string
|
output: string
|
||||||
serve: boolean
|
serve: boolean
|
||||||
fastRebuild: boolean
|
watch: boolean
|
||||||
port: number
|
port: number
|
||||||
wsPort: number
|
wsPort: number
|
||||||
remoteDevHost?: string
|
remoteDevHost?: string
|
||||||
@@ -18,4 +18,8 @@ export interface BuildCtx {
|
|||||||
argv: Argv
|
argv: Argv
|
||||||
cfg: QuartzConfig
|
cfg: QuartzConfig
|
||||||
allSlugs: FullSlug[]
|
allSlugs: FullSlug[]
|
||||||
|
allFiles: FilePath[]
|
||||||
|
incremental: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type WorkerSerializableBuildCtx = Omit<BuildCtx, "cfg">
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
import test, { describe, beforeEach } from "node:test"
|
import test, { describe, beforeEach } from "node:test"
|
||||||
import assert from "node:assert"
|
import assert from "node:assert"
|
||||||
import { FileTrieNode } from "./fileTrie"
|
import { FileTrieNode } from "./fileTrie"
|
||||||
|
import { FullSlug } from "./path"
|
||||||
|
|
||||||
interface TestData {
|
interface TestData {
|
||||||
title: string
|
title: string
|
||||||
slug: string
|
slug: string
|
||||||
|
filePath: string
|
||||||
}
|
}
|
||||||
|
|
||||||
describe("FileTrie", () => {
|
describe("FileTrie", () => {
|
||||||
@@ -26,11 +28,24 @@ describe("FileTrie", () => {
|
|||||||
const data = {
|
const data = {
|
||||||
title: "Test Title",
|
title: "Test Title",
|
||||||
slug: "test",
|
slug: "test",
|
||||||
|
filePath: "test.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
trie.add(data)
|
trie.add(data)
|
||||||
assert.strictEqual(trie.children[0].displayName, "Test Title")
|
assert.strictEqual(trie.children[0].displayName, "Test Title")
|
||||||
})
|
})
|
||||||
|
|
||||||
|
test("should be able to set displayName", () => {
|
||||||
|
const data = {
|
||||||
|
title: "Test Title",
|
||||||
|
slug: "test",
|
||||||
|
filePath: "test.md",
|
||||||
|
}
|
||||||
|
|
||||||
|
trie.add(data)
|
||||||
|
trie.children[0].displayName = "Modified"
|
||||||
|
assert.strictEqual(trie.children[0].displayName, "Modified")
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe("add", () => {
|
describe("add", () => {
|
||||||
@@ -38,6 +53,7 @@ describe("FileTrie", () => {
|
|||||||
const data = {
|
const data = {
|
||||||
title: "Test",
|
title: "Test",
|
||||||
slug: "test",
|
slug: "test",
|
||||||
|
filePath: "test.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
trie.add(data)
|
trie.add(data)
|
||||||
@@ -50,6 +66,7 @@ describe("FileTrie", () => {
|
|||||||
const data = {
|
const data = {
|
||||||
title: "Index",
|
title: "Index",
|
||||||
slug: "index",
|
slug: "index",
|
||||||
|
filePath: "index.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
trie.add(data)
|
trie.add(data)
|
||||||
@@ -61,11 +78,13 @@ describe("FileTrie", () => {
|
|||||||
const data1 = {
|
const data1 = {
|
||||||
title: "Nested",
|
title: "Nested",
|
||||||
slug: "folder/test",
|
slug: "folder/test",
|
||||||
|
filePath: "folder/test.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
const data2 = {
|
const data2 = {
|
||||||
title: "Really nested index",
|
title: "Really nested index",
|
||||||
slug: "a/b/c/index",
|
slug: "a/b/c/index",
|
||||||
|
filePath: "a/b/c/index.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
trie.add(data1)
|
trie.add(data1)
|
||||||
@@ -92,8 +111,8 @@ describe("FileTrie", () => {
|
|||||||
|
|
||||||
describe("filter", () => {
|
describe("filter", () => {
|
||||||
test("should filter nodes based on condition", () => {
|
test("should filter nodes based on condition", () => {
|
||||||
const data1 = { title: "Test1", slug: "test1" }
|
const data1 = { title: "Test1", slug: "test1", filePath: "test1.md" }
|
||||||
const data2 = { title: "Test2", slug: "test2" }
|
const data2 = { title: "Test2", slug: "test2", filePath: "test2.md" }
|
||||||
|
|
||||||
trie.add(data1)
|
trie.add(data1)
|
||||||
trie.add(data2)
|
trie.add(data2)
|
||||||
@@ -106,8 +125,8 @@ describe("FileTrie", () => {
|
|||||||
|
|
||||||
describe("map", () => {
|
describe("map", () => {
|
||||||
test("should apply function to all nodes", () => {
|
test("should apply function to all nodes", () => {
|
||||||
const data1 = { title: "Test1", slug: "test1" }
|
const data1 = { title: "Test1", slug: "test1", filePath: "test1.md" }
|
||||||
const data2 = { title: "Test2", slug: "test2" }
|
const data2 = { title: "Test2", slug: "test2", filePath: "test2.md" }
|
||||||
|
|
||||||
trie.add(data1)
|
trie.add(data1)
|
||||||
trie.add(data2)
|
trie.add(data2)
|
||||||
@@ -121,12 +140,41 @@ describe("FileTrie", () => {
|
|||||||
assert.strictEqual(trie.children[0].displayName, "Modified")
|
assert.strictEqual(trie.children[0].displayName, "Modified")
|
||||||
assert.strictEqual(trie.children[1].displayName, "Modified")
|
assert.strictEqual(trie.children[1].displayName, "Modified")
|
||||||
})
|
})
|
||||||
|
|
||||||
|
test("map over folders should work", () => {
|
||||||
|
const data1 = { title: "Test1", slug: "test1", filePath: "test1.md" }
|
||||||
|
const data2 = {
|
||||||
|
title: "Test2",
|
||||||
|
slug: "a/b-with-space/test2",
|
||||||
|
filePath: "a/b with space/test2.md",
|
||||||
|
}
|
||||||
|
|
||||||
|
trie.add(data1)
|
||||||
|
trie.add(data2)
|
||||||
|
|
||||||
|
trie.map((node) => {
|
||||||
|
if (node.isFolder) {
|
||||||
|
node.displayName = `Folder: ${node.displayName}`
|
||||||
|
} else {
|
||||||
|
node.displayName = `File: ${node.displayName}`
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.strictEqual(trie.children[0].displayName, "File: Test1")
|
||||||
|
assert.strictEqual(trie.children[1].displayName, "Folder: a")
|
||||||
|
assert.strictEqual(trie.children[1].children[0].displayName, "Folder: b with space")
|
||||||
|
assert.strictEqual(trie.children[1].children[0].children[0].displayName, "File: Test2")
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe("entries", () => {
|
describe("entries", () => {
|
||||||
test("should return all entries", () => {
|
test("should return all entries", () => {
|
||||||
const data1 = { title: "Test1", slug: "test1" }
|
const data1 = { title: "Test1", slug: "test1", filePath: "test1.md" }
|
||||||
const data2 = { title: "Test2", slug: "a/b/test2" }
|
const data2 = {
|
||||||
|
title: "Test2",
|
||||||
|
slug: "a/b-with-space/test2",
|
||||||
|
filePath: "a/b with space/test2.md",
|
||||||
|
}
|
||||||
|
|
||||||
trie.add(data1)
|
trie.add(data1)
|
||||||
trie.add(data2)
|
trie.add(data2)
|
||||||
@@ -138,26 +186,117 @@ describe("FileTrie", () => {
|
|||||||
["index", trie.data],
|
["index", trie.data],
|
||||||
["test1", data1],
|
["test1", data1],
|
||||||
["a/index", null],
|
["a/index", null],
|
||||||
["a/b/index", null],
|
["a/b-with-space/index", null],
|
||||||
["a/b/test2", data2],
|
["a/b-with-space/test2", data2],
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
describe("fromEntries", () => {
|
||||||
|
test("nested", () => {
|
||||||
|
const trie = FileTrieNode.fromEntries([
|
||||||
|
["index" as FullSlug, { title: "Root", slug: "index", filePath: "index.md" }],
|
||||||
|
[
|
||||||
|
"folder/file1" as FullSlug,
|
||||||
|
{ title: "File 1", slug: "folder/file1", filePath: "folder/file1.md" },
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"folder/index" as FullSlug,
|
||||||
|
{ title: "Folder Index", slug: "folder/index", filePath: "folder/index.md" },
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"folder/file2" as FullSlug,
|
||||||
|
{ title: "File 2", slug: "folder/file2", filePath: "folder/file2.md" },
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"folder/folder2/index" as FullSlug,
|
||||||
|
{
|
||||||
|
title: "Subfolder Index",
|
||||||
|
slug: "folder/folder2/index",
|
||||||
|
filePath: "folder/folder2/index.md",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
])
|
||||||
|
|
||||||
|
assert.strictEqual(trie.children.length, 1)
|
||||||
|
assert.strictEqual(trie.children[0].slug, "folder/index")
|
||||||
|
assert.strictEqual(trie.children[0].children.length, 3)
|
||||||
|
assert.strictEqual(trie.children[0].children[0].slug, "folder/file1")
|
||||||
|
assert.strictEqual(trie.children[0].children[1].slug, "folder/file2")
|
||||||
|
assert.strictEqual(trie.children[0].children[2].slug, "folder/folder2/index")
|
||||||
|
assert.strictEqual(trie.children[0].children[2].children.length, 0)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("findNode", () => {
|
||||||
|
test("should find root node with empty path", () => {
|
||||||
|
const data = { title: "Root", slug: "index", filePath: "index.md" }
|
||||||
|
trie.add(data)
|
||||||
|
const found = trie.findNode([])
|
||||||
|
assert.strictEqual(found, trie)
|
||||||
|
})
|
||||||
|
|
||||||
|
test("should find node at first level", () => {
|
||||||
|
const data = { title: "Test", slug: "test", filePath: "test.md" }
|
||||||
|
trie.add(data)
|
||||||
|
const found = trie.findNode(["test"])
|
||||||
|
assert.strictEqual(found?.data, data)
|
||||||
|
})
|
||||||
|
|
||||||
|
test("should find nested node", () => {
|
||||||
|
const data = {
|
||||||
|
title: "Nested",
|
||||||
|
slug: "folder/subfolder/test",
|
||||||
|
filePath: "folder/subfolder/test.md",
|
||||||
|
}
|
||||||
|
trie.add(data)
|
||||||
|
const found = trie.findNode(["folder", "subfolder", "test"])
|
||||||
|
assert.strictEqual(found?.data, data)
|
||||||
|
|
||||||
|
// should find the folder and subfolder indexes too
|
||||||
|
assert.strictEqual(
|
||||||
|
trie.findNode(["folder", "subfolder", "index"]),
|
||||||
|
trie.children[0].children[0],
|
||||||
|
)
|
||||||
|
assert.strictEqual(trie.findNode(["folder", "index"]), trie.children[0])
|
||||||
|
})
|
||||||
|
|
||||||
|
test("should return undefined for non-existent path", () => {
|
||||||
|
const data = { title: "Test", slug: "test", filePath: "test.md" }
|
||||||
|
trie.add(data)
|
||||||
|
const found = trie.findNode(["nonexistent"])
|
||||||
|
assert.strictEqual(found, undefined)
|
||||||
|
})
|
||||||
|
|
||||||
|
test("should return undefined for partial path", () => {
|
||||||
|
const data = {
|
||||||
|
title: "Nested",
|
||||||
|
slug: "folder/subfolder/test",
|
||||||
|
filePath: "folder/subfolder/test.md",
|
||||||
|
}
|
||||||
|
trie.add(data)
|
||||||
|
const found = trie.findNode(["folder"])
|
||||||
|
assert.strictEqual(found?.data, null)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
describe("getFolderPaths", () => {
|
describe("getFolderPaths", () => {
|
||||||
test("should return all folder paths", () => {
|
test("should return all folder paths", () => {
|
||||||
const data1 = {
|
const data1 = {
|
||||||
title: "Root",
|
title: "Root",
|
||||||
slug: "index",
|
slug: "index",
|
||||||
|
filePath: "index.md",
|
||||||
}
|
}
|
||||||
const data2 = {
|
const data2 = {
|
||||||
title: "Test",
|
title: "Test",
|
||||||
slug: "folder/subfolder/test",
|
slug: "folder/subfolder/test",
|
||||||
|
filePath: "folder/subfolder/test.md",
|
||||||
}
|
}
|
||||||
const data3 = {
|
const data3 = {
|
||||||
title: "Folder Index",
|
title: "Folder Index",
|
||||||
slug: "abc/index",
|
slug: "abc/index",
|
||||||
|
filePath: "abc/index.md",
|
||||||
}
|
}
|
||||||
|
|
||||||
trie.add(data1)
|
trie.add(data1)
|
||||||
@@ -176,9 +315,9 @@ describe("FileTrie", () => {
|
|||||||
|
|
||||||
describe("sort", () => {
|
describe("sort", () => {
|
||||||
test("should sort nodes according to sort function", () => {
|
test("should sort nodes according to sort function", () => {
|
||||||
const data1 = { title: "A", slug: "a" }
|
const data1 = { title: "A", slug: "a", filePath: "a.md" }
|
||||||
const data2 = { title: "B", slug: "b" }
|
const data2 = { title: "B", slug: "b", filePath: "b.md" }
|
||||||
const data3 = { title: "C", slug: "c" }
|
const data3 = { title: "C", slug: "c", filePath: "c.md" }
|
||||||
|
|
||||||
trie.add(data3)
|
trie.add(data3)
|
||||||
trie.add(data1)
|
trie.add(data1)
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import { FullSlug, joinSegments } from "./path"
|
|||||||
interface FileTrieData {
|
interface FileTrieData {
|
||||||
slug: string
|
slug: string
|
||||||
title: string
|
title: string
|
||||||
|
filePath: string
|
||||||
}
|
}
|
||||||
|
|
||||||
export class FileTrieNode<T extends FileTrieData = ContentDetails> {
|
export class FileTrieNode<T extends FileTrieData = ContentDetails> {
|
||||||
@@ -11,6 +12,11 @@ export class FileTrieNode<T extends FileTrieData = ContentDetails> {
|
|||||||
children: Array<FileTrieNode<T>>
|
children: Array<FileTrieNode<T>>
|
||||||
|
|
||||||
private slugSegments: string[]
|
private slugSegments: string[]
|
||||||
|
// prefer showing the file path segment over the slug segment
|
||||||
|
// so that folders that dont have index files can be shown as is
|
||||||
|
// without dashes in the slug
|
||||||
|
private fileSegmentHint?: string
|
||||||
|
private displayNameOverride?: string
|
||||||
data: T | null
|
data: T | null
|
||||||
|
|
||||||
constructor(segments: string[], data?: T) {
|
constructor(segments: string[], data?: T) {
|
||||||
@@ -18,10 +24,18 @@ export class FileTrieNode<T extends FileTrieData = ContentDetails> {
|
|||||||
this.slugSegments = segments
|
this.slugSegments = segments
|
||||||
this.data = data ?? null
|
this.data = data ?? null
|
||||||
this.isFolder = false
|
this.isFolder = false
|
||||||
|
this.displayNameOverride = undefined
|
||||||
}
|
}
|
||||||
|
|
||||||
get displayName(): string {
|
get displayName(): string {
|
||||||
return this.data?.title ?? this.slugSegment ?? ""
|
const nonIndexTitle = this.data?.title === "index" ? undefined : this.data?.title
|
||||||
|
return (
|
||||||
|
this.displayNameOverride ?? nonIndexTitle ?? this.fileSegmentHint ?? this.slugSegment ?? ""
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
set displayName(name: string) {
|
||||||
|
this.displayNameOverride = name
|
||||||
}
|
}
|
||||||
|
|
||||||
get slug(): FullSlug {
|
get slug(): FullSlug {
|
||||||
@@ -63,6 +77,9 @@ export class FileTrieNode<T extends FileTrieData = ContentDetails> {
|
|||||||
// recursive case, we are not at the end of the path
|
// recursive case, we are not at the end of the path
|
||||||
const child =
|
const child =
|
||||||
this.children.find((c) => c.slugSegment === segment) ?? this.makeChild(path, undefined)
|
this.children.find((c) => c.slugSegment === segment) ?? this.makeChild(path, undefined)
|
||||||
|
|
||||||
|
const fileParts = file.filePath.split("/")
|
||||||
|
child.fileSegmentHint = fileParts.at(-path.length)
|
||||||
child.insert(path.slice(1), file)
|
child.insert(path.slice(1), file)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -72,6 +89,14 @@ export class FileTrieNode<T extends FileTrieData = ContentDetails> {
|
|||||||
this.insert(file.slug.split("/"), file)
|
this.insert(file.slug.split("/"), file)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
findNode(path: string[]): FileTrieNode<T> | undefined {
|
||||||
|
if (path.length === 0 || (path.length === 1 && path[0] === "index")) {
|
||||||
|
return this
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.children.find((c) => c.slugSegment === path[0])?.findNode(path.slice(1))
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Filter trie nodes. Behaves similar to `Array.prototype.filter()`, but modifies tree in place
|
* Filter trie nodes. Behaves similar to `Array.prototype.filter()`, but modifies tree in place
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -1,26 +1,56 @@
|
|||||||
import { Spinner } from "cli-spinner"
|
import truncate from "ansi-truncate"
|
||||||
|
import readline from "readline"
|
||||||
|
|
||||||
export class QuartzLogger {
|
export class QuartzLogger {
|
||||||
verbose: boolean
|
verbose: boolean
|
||||||
spinner: Spinner | undefined
|
private spinnerInterval: NodeJS.Timeout | undefined
|
||||||
|
private spinnerText: string = ""
|
||||||
|
private updateSuffix: string = ""
|
||||||
|
private spinnerIndex: number = 0
|
||||||
|
private readonly spinnerChars = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
|
||||||
|
|
||||||
constructor(verbose: boolean) {
|
constructor(verbose: boolean) {
|
||||||
this.verbose = verbose
|
const isInteractiveTerminal =
|
||||||
|
process.stdout.isTTY && process.env.TERM !== "dumb" && !process.env.CI
|
||||||
|
this.verbose = verbose || !isInteractiveTerminal
|
||||||
}
|
}
|
||||||
|
|
||||||
start(text: string) {
|
start(text: string) {
|
||||||
|
this.spinnerText = text
|
||||||
|
|
||||||
if (this.verbose) {
|
if (this.verbose) {
|
||||||
console.log(text)
|
console.log(text)
|
||||||
} else {
|
} else {
|
||||||
this.spinner = new Spinner(`%s ${text}`)
|
this.spinnerIndex = 0
|
||||||
this.spinner.setSpinnerString(18)
|
this.spinnerInterval = setInterval(() => {
|
||||||
this.spinner.start()
|
readline.clearLine(process.stdout, 0)
|
||||||
|
readline.cursorTo(process.stdout, 0)
|
||||||
|
|
||||||
|
const columns = process.stdout.columns || 80
|
||||||
|
let output = `${this.spinnerChars[this.spinnerIndex]} ${this.spinnerText}`
|
||||||
|
if (this.updateSuffix) {
|
||||||
|
output += `: ${this.updateSuffix}`
|
||||||
|
}
|
||||||
|
|
||||||
|
const truncated = truncate(output, columns)
|
||||||
|
process.stdout.write(truncated)
|
||||||
|
this.spinnerIndex = (this.spinnerIndex + 1) % this.spinnerChars.length
|
||||||
|
}, 20)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
updateText(text: string) {
|
||||||
|
this.updateSuffix = text
|
||||||
|
}
|
||||||
|
|
||||||
end(text?: string) {
|
end(text?: string) {
|
||||||
if (!this.verbose) {
|
if (!this.verbose && this.spinnerInterval) {
|
||||||
this.spinner!.stop(true)
|
clearInterval(this.spinnerInterval)
|
||||||
|
this.spinnerInterval = undefined
|
||||||
|
readline.clearLine(process.stdout, 0)
|
||||||
|
readline.cursorTo(process.stdout, 0)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (text) {
|
if (text) {
|
||||||
console.log(text)
|
console.log(text)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,28 +1,66 @@
|
|||||||
|
import { promises as fs } from "fs"
|
||||||
import { FontWeight, SatoriOptions } from "satori/wasm"
|
import { FontWeight, SatoriOptions } from "satori/wasm"
|
||||||
import { GlobalConfiguration } from "../cfg"
|
import { GlobalConfiguration } from "../cfg"
|
||||||
import { QuartzPluginData } from "../plugins/vfile"
|
import { QuartzPluginData } from "../plugins/vfile"
|
||||||
import { JSXInternal } from "preact/src/jsx"
|
import { JSXInternal } from "preact/src/jsx"
|
||||||
import { ThemeKey } from "./theme"
|
import { FontSpecification, getFontSpecificationName, ThemeKey } from "./theme"
|
||||||
|
import path from "path"
|
||||||
|
import { QUARTZ } from "./path"
|
||||||
|
import { formatDate, getDate } from "../components/Date"
|
||||||
|
import readingTime from "reading-time"
|
||||||
|
import { i18n } from "../i18n"
|
||||||
|
import chalk from "chalk"
|
||||||
|
|
||||||
/**
|
const defaultHeaderWeight = [700]
|
||||||
* Get an array of `FontOptions` (for satori) given google font names
|
const defaultBodyWeight = [400]
|
||||||
* @param headerFontName name of google font used for header
|
export async function getSatoriFonts(headerFont: FontSpecification, bodyFont: FontSpecification) {
|
||||||
* @param bodyFontName name of google font used for body
|
// Get all weights for header and body fonts
|
||||||
* @returns FontOptions for header and body
|
const headerWeights: FontWeight[] = (
|
||||||
*/
|
typeof headerFont === "string"
|
||||||
export async function getSatoriFont(headerFontName: string, bodyFontName: string) {
|
? defaultHeaderWeight
|
||||||
const headerWeight = 700 as FontWeight
|
: (headerFont.weights ?? defaultHeaderWeight)
|
||||||
const bodyWeight = 400 as FontWeight
|
) as FontWeight[]
|
||||||
|
const bodyWeights: FontWeight[] = (
|
||||||
|
typeof bodyFont === "string" ? defaultBodyWeight : (bodyFont.weights ?? defaultBodyWeight)
|
||||||
|
) as FontWeight[]
|
||||||
|
|
||||||
// Fetch fonts
|
const headerFontName = typeof headerFont === "string" ? headerFont : headerFont.name
|
||||||
const headerFont = await fetchTtf(headerFontName, headerWeight)
|
const bodyFontName = typeof bodyFont === "string" ? bodyFont : bodyFont.name
|
||||||
const bodyFont = await fetchTtf(bodyFontName, bodyWeight)
|
|
||||||
|
|
||||||
// Convert fonts to satori font format and return
|
// Fetch fonts for all weights and convert to satori format in one go
|
||||||
|
const headerFontPromises = headerWeights.map(async (weight) => {
|
||||||
|
const data = await fetchTtf(headerFontName, weight)
|
||||||
|
if (!data) return null
|
||||||
|
return {
|
||||||
|
name: headerFontName,
|
||||||
|
data,
|
||||||
|
weight,
|
||||||
|
style: "normal" as const,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const bodyFontPromises = bodyWeights.map(async (weight) => {
|
||||||
|
const data = await fetchTtf(bodyFontName, weight)
|
||||||
|
if (!data) return null
|
||||||
|
return {
|
||||||
|
name: bodyFontName,
|
||||||
|
data,
|
||||||
|
weight,
|
||||||
|
style: "normal" as const,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const [headerFonts, bodyFonts] = await Promise.all([
|
||||||
|
Promise.all(headerFontPromises),
|
||||||
|
Promise.all(bodyFontPromises),
|
||||||
|
])
|
||||||
|
|
||||||
|
// Filter out any failed fetches and combine header and body fonts
|
||||||
const fonts: SatoriOptions["fonts"] = [
|
const fonts: SatoriOptions["fonts"] = [
|
||||||
{ name: headerFontName, data: headerFont, weight: headerWeight, style: "normal" },
|
...headerFonts.filter((font): font is NonNullable<typeof font> => font !== null),
|
||||||
{ name: bodyFontName, data: bodyFont, weight: bodyWeight, style: "normal" },
|
...bodyFonts.filter((font): font is NonNullable<typeof font> => font !== null),
|
||||||
]
|
]
|
||||||
|
|
||||||
return fonts
|
return fonts
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -32,32 +70,49 @@ export async function getSatoriFont(headerFontName: string, bodyFontName: string
|
|||||||
* @param weight what font weight to fetch font
|
* @param weight what font weight to fetch font
|
||||||
* @returns `.ttf` file of google font
|
* @returns `.ttf` file of google font
|
||||||
*/
|
*/
|
||||||
async function fetchTtf(fontName: string, weight: FontWeight): Promise<ArrayBuffer> {
|
export async function fetchTtf(
|
||||||
|
rawFontName: string,
|
||||||
|
weight: FontWeight,
|
||||||
|
): Promise<Buffer<ArrayBufferLike> | undefined> {
|
||||||
|
const fontName = rawFontName.replaceAll(" ", "+")
|
||||||
|
const cacheKey = `${fontName}-${weight}`
|
||||||
|
const cacheDir = path.join(QUARTZ, ".quartz-cache", "fonts")
|
||||||
|
const cachePath = path.join(cacheDir, cacheKey)
|
||||||
|
|
||||||
|
// Check if font exists in cache
|
||||||
try {
|
try {
|
||||||
// Get css file from google fonts
|
await fs.access(cachePath)
|
||||||
const cssResponse = await fetch(
|
return fs.readFile(cachePath)
|
||||||
`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
|
|
||||||
} catch (error) {
|
} 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) {
|
||||||
|
console.log(
|
||||||
|
chalk.yellow(
|
||||||
|
`\nWarning: Failed to fetch font ${rawFontName} with weight ${weight}, got ${cssResponse.statusText}`,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// fontData is an ArrayBuffer containing the .ttf file data
|
||||||
|
const fontResponse = await fetch(match[1])
|
||||||
|
const fontData = Buffer.from(await fontResponse.arrayBuffer())
|
||||||
|
await fs.mkdir(cacheDir, { recursive: true })
|
||||||
|
await fs.writeFile(cachePath, fontData)
|
||||||
|
|
||||||
|
return fontData
|
||||||
}
|
}
|
||||||
|
|
||||||
export type SocialImageOptions = {
|
export type SocialImageOptions = {
|
||||||
@@ -108,22 +163,10 @@ export type ImageOptions = {
|
|||||||
* what description to use as body in image
|
* what description to use as body in image
|
||||||
*/
|
*/
|
||||||
description: string
|
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)
|
* header + body font to be used when generating satori image (as promise to work around sync in component)
|
||||||
*/
|
*/
|
||||||
fontsPromise: Promise<SatoriOptions["fonts"]>
|
fonts: SatoriOptions["fonts"]
|
||||||
/**
|
/**
|
||||||
* `GlobalConfiguration` of quartz (used for theme/typography)
|
* `GlobalConfiguration` of quartz (used for theme/typography)
|
||||||
*/
|
*/
|
||||||
@@ -140,69 +183,104 @@ export const defaultImage: SocialImageOptions["imageStructure"] = (
|
|||||||
{ colorScheme }: UserOpts,
|
{ colorScheme }: UserOpts,
|
||||||
title: string,
|
title: string,
|
||||||
description: string,
|
description: string,
|
||||||
fonts: SatoriOptions["fonts"],
|
_fonts: SatoriOptions["fonts"],
|
||||||
_fileData: QuartzPluginData,
|
fileData: QuartzPluginData,
|
||||||
) => {
|
) => {
|
||||||
const fontBreakPoint = 22
|
const fontBreakPoint = 32
|
||||||
const useSmallerFont = title.length > fontBreakPoint
|
const useSmallerFont = title.length > fontBreakPoint
|
||||||
const iconPath = `https://${cfg.baseUrl}/static/icon.png`
|
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
|
||||||
|
|
||||||
|
// Calculate reading time
|
||||||
|
const { minutes } = readingTime(fileData.text ?? "")
|
||||||
|
const readingTimeText = i18n(cfg.locale).components.contentMeta.readingTime({
|
||||||
|
minutes: Math.ceil(minutes),
|
||||||
|
})
|
||||||
|
|
||||||
|
// Get tags if available
|
||||||
|
const tags = fileData.frontmatter?.tags ?? []
|
||||||
|
const bodyFont = getFontSpecificationName(cfg.theme.typography.body)
|
||||||
|
const headerFont = getFontSpecificationName(cfg.theme.typography.header)
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
style={{
|
style={{
|
||||||
display: "flex",
|
display: "flex",
|
||||||
flexDirection: "column",
|
flexDirection: "column",
|
||||||
justifyContent: "center",
|
|
||||||
alignItems: "center",
|
|
||||||
height: "100%",
|
height: "100%",
|
||||||
width: "100%",
|
width: "100%",
|
||||||
backgroundColor: cfg.theme.colors[colorScheme].light,
|
backgroundColor: cfg.theme.colors[colorScheme].light,
|
||||||
gap: "2rem",
|
padding: "2.5rem",
|
||||||
padding: "1.5rem 5rem",
|
fontFamily: bodyFont,
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
|
{/* Header Section */}
|
||||||
<div
|
<div
|
||||||
style={{
|
style={{
|
||||||
display: "flex",
|
display: "flex",
|
||||||
alignItems: "center",
|
alignItems: "center",
|
||||||
width: "100%",
|
gap: "1rem",
|
||||||
flexDirection: "row",
|
marginBottom: "0.5rem",
|
||||||
gap: "2.5rem",
|
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<img src={iconPath} width={135} height={135} />
|
<img
|
||||||
|
src={iconPath}
|
||||||
|
width={56}
|
||||||
|
height={56}
|
||||||
|
style={{
|
||||||
|
borderRadius: "50%",
|
||||||
|
}}
|
||||||
|
/>
|
||||||
<div
|
<div
|
||||||
style={{
|
style={{
|
||||||
display: "flex",
|
display: "flex",
|
||||||
|
fontSize: 32,
|
||||||
|
color: cfg.theme.colors[colorScheme].gray,
|
||||||
|
fontFamily: bodyFont,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{cfg.baseUrl}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Title Section */}
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
marginTop: "1rem",
|
||||||
|
marginBottom: "1.5rem",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<h1
|
||||||
|
style={{
|
||||||
|
margin: 0,
|
||||||
|
fontSize: useSmallerFont ? 64 : 72,
|
||||||
|
fontFamily: headerFont,
|
||||||
|
fontWeight: 700,
|
||||||
color: cfg.theme.colors[colorScheme].dark,
|
color: cfg.theme.colors[colorScheme].dark,
|
||||||
fontSize: useSmallerFont ? 70 : 82,
|
lineHeight: 1.2,
|
||||||
fontFamily: fonts[0].name,
|
display: "-webkit-box",
|
||||||
maxWidth: "70%",
|
WebkitBoxOrient: "vertical",
|
||||||
|
WebkitLineClamp: 2,
|
||||||
overflow: "hidden",
|
overflow: "hidden",
|
||||||
textOverflow: "ellipsis",
|
textOverflow: "ellipsis",
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<p
|
{title}
|
||||||
style={{
|
</h1>
|
||||||
margin: 0,
|
|
||||||
overflow: "hidden",
|
|
||||||
textOverflow: "ellipsis",
|
|
||||||
whiteSpace: "nowrap",
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
{title}
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{/* Description Section */}
|
||||||
<div
|
<div
|
||||||
style={{
|
style={{
|
||||||
display: "flex",
|
display: "flex",
|
||||||
color: cfg.theme.colors[colorScheme].dark,
|
flex: 1,
|
||||||
fontSize: 44,
|
fontSize: 36,
|
||||||
fontFamily: fonts[1].name,
|
color: cfg.theme.colors[colorScheme].darkgray,
|
||||||
maxWidth: "100%",
|
lineHeight: 1.4,
|
||||||
maxHeight: "40%",
|
|
||||||
overflow: "hidden",
|
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
<p
|
<p
|
||||||
@@ -210,7 +288,7 @@ export const defaultImage: SocialImageOptions["imageStructure"] = (
|
|||||||
margin: 0,
|
margin: 0,
|
||||||
display: "-webkit-box",
|
display: "-webkit-box",
|
||||||
WebkitBoxOrient: "vertical",
|
WebkitBoxOrient: "vertical",
|
||||||
WebkitLineClamp: 3,
|
WebkitLineClamp: 5,
|
||||||
overflow: "hidden",
|
overflow: "hidden",
|
||||||
textOverflow: "ellipsis",
|
textOverflow: "ellipsis",
|
||||||
}}
|
}}
|
||||||
@@ -218,6 +296,88 @@ export const defaultImage: SocialImageOptions["imageStructure"] = (
|
|||||||
{description}
|
{description}
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
{/* Footer with Metadata */}
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
alignItems: "center",
|
||||||
|
justifyContent: "space-between",
|
||||||
|
marginTop: "2rem",
|
||||||
|
paddingTop: "2rem",
|
||||||
|
borderTop: `1px solid ${cfg.theme.colors[colorScheme].lightgray}`,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{/* Left side - Date and Reading Time */}
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
alignItems: "center",
|
||||||
|
gap: "2rem",
|
||||||
|
color: cfg.theme.colors[colorScheme].gray,
|
||||||
|
fontSize: 28,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{date && (
|
||||||
|
<div style={{ display: "flex", alignItems: "center" }}>
|
||||||
|
<svg
|
||||||
|
style={{ marginRight: "0.5rem" }}
|
||||||
|
width="28"
|
||||||
|
height="28"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
fill="none"
|
||||||
|
stroke="currentColor"
|
||||||
|
>
|
||||||
|
<rect x="3" y="4" width="18" height="18" rx="2" ry="2"></rect>
|
||||||
|
<line x1="16" y1="2" x2="16" y2="6"></line>
|
||||||
|
<line x1="8" y1="2" x2="8" y2="6"></line>
|
||||||
|
<line x1="3" y1="10" x2="21" y2="10"></line>
|
||||||
|
</svg>
|
||||||
|
{date}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
<div style={{ display: "flex", alignItems: "center" }}>
|
||||||
|
<svg
|
||||||
|
style={{ marginRight: "0.5rem" }}
|
||||||
|
width="28"
|
||||||
|
height="28"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
fill="none"
|
||||||
|
stroke="currentColor"
|
||||||
|
>
|
||||||
|
<circle cx="12" cy="12" r="10"></circle>
|
||||||
|
<polyline points="12 6 12 12 16 14"></polyline>
|
||||||
|
</svg>
|
||||||
|
{readingTimeText}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Right side - Tags */}
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
gap: "0.5rem",
|
||||||
|
flexWrap: "wrap",
|
||||||
|
justifyContent: "flex-end",
|
||||||
|
maxWidth: "60%",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{tags.slice(0, 3).map((tag: string) => (
|
||||||
|
<div
|
||||||
|
style={{
|
||||||
|
display: "flex",
|
||||||
|
padding: "0.5rem 1rem",
|
||||||
|
backgroundColor: cfg.theme.colors[colorScheme].highlight,
|
||||||
|
color: cfg.theme.colors[colorScheme].secondary,
|
||||||
|
borderRadius: "10px",
|
||||||
|
fontSize: 24,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
#{tag}
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ export type RelativeURL = SlugLike<"relative">
|
|||||||
export function isRelativeURL(s: string): s is RelativeURL {
|
export function isRelativeURL(s: string): s is RelativeURL {
|
||||||
const validStart = /^\.{1,2}/.test(s)
|
const validStart = /^\.{1,2}/.test(s)
|
||||||
const validEnding = !endsWith(s, "index")
|
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 {
|
export function getFullSlug(window: Window): FullSlug {
|
||||||
@@ -61,7 +61,7 @@ function sluggify(s: string): string {
|
|||||||
|
|
||||||
export function slugifyFilePath(fp: FilePath, excludeExt?: boolean): FullSlug {
|
export function slugifyFilePath(fp: FilePath, excludeExt?: boolean): FullSlug {
|
||||||
fp = stripSlashes(fp) as FilePath
|
fp = stripSlashes(fp) as FilePath
|
||||||
let ext = _getFileExtension(fp)
|
let ext = getFileExtension(fp)
|
||||||
const withoutFileExt = fp.replace(new RegExp(ext + "$"), "")
|
const withoutFileExt = fp.replace(new RegExp(ext + "$"), "")
|
||||||
if (excludeExt || [".md", ".html", undefined].includes(ext)) {
|
if (excludeExt || [".md", ".html", undefined].includes(ext)) {
|
||||||
ext = ""
|
ext = ""
|
||||||
@@ -247,7 +247,7 @@ export function transformLink(src: FullSlug, target: string, opts: TransformOpti
|
|||||||
}
|
}
|
||||||
|
|
||||||
// path helpers
|
// path helpers
|
||||||
function isFolderPath(fplike: string): boolean {
|
export function isFolderPath(fplike: string): boolean {
|
||||||
return (
|
return (
|
||||||
fplike.endsWith("/") ||
|
fplike.endsWith("/") ||
|
||||||
endsWith(fplike, "index") ||
|
endsWith(fplike, "index") ||
|
||||||
@@ -260,7 +260,7 @@ export function endsWith(s: string, suffix: string): boolean {
|
|||||||
return s === suffix || s.endsWith("/" + suffix)
|
return s === suffix || s.endsWith("/" + suffix)
|
||||||
}
|
}
|
||||||
|
|
||||||
function trimSuffix(s: string, suffix: string): string {
|
export function trimSuffix(s: string, suffix: string): string {
|
||||||
if (endsWith(s, suffix)) {
|
if (endsWith(s, suffix)) {
|
||||||
s = s.slice(0, -suffix.length)
|
s = s.slice(0, -suffix.length)
|
||||||
}
|
}
|
||||||
@@ -272,10 +272,10 @@ function containsForbiddenCharacters(s: string): boolean {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function _hasFileExtension(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]
|
return s.match(/\.[A-Za-z0-9]+$/)?.[0]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ interface Colors {
|
|||||||
darkMode: ColorScheme
|
darkMode: ColorScheme
|
||||||
}
|
}
|
||||||
|
|
||||||
type FontSpecification =
|
export type FontSpecification =
|
||||||
| string
|
| string
|
||||||
| {
|
| {
|
||||||
name: 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`
|
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[]) {
|
export function joinStyles(theme: Theme, ...stylesheet: string[]) {
|
||||||
return `
|
return `
|
||||||
${stylesheet.join("\n\n")}
|
${stylesheet.join("\n\n")}
|
||||||
@@ -105,9 +135,9 @@ ${stylesheet.join("\n\n")}
|
|||||||
--highlight: ${theme.colors.lightMode.highlight};
|
--highlight: ${theme.colors.lightMode.highlight};
|
||||||
--textHighlight: ${theme.colors.lightMode.textHighlight};
|
--textHighlight: ${theme.colors.lightMode.textHighlight};
|
||||||
|
|
||||||
--headerFont: "${theme.typography.header}", ${DEFAULT_SANS_SERIF};
|
--headerFont: "${getFontSpecificationName(theme.typography.header)}", ${DEFAULT_SANS_SERIF};
|
||||||
--bodyFont: "${theme.typography.body}", ${DEFAULT_SANS_SERIF};
|
--bodyFont: "${getFontSpecificationName(theme.typography.body)}", ${DEFAULT_SANS_SERIF};
|
||||||
--codeFont: "${theme.typography.code}", ${DEFAULT_MONO};
|
--codeFont: "${getFontSpecificationName(theme.typography.code)}", ${DEFAULT_MONO};
|
||||||
}
|
}
|
||||||
|
|
||||||
:root[saved-theme="dark"] {
|
:root[saved-theme="dark"] {
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
import sourceMapSupport from "source-map-support"
|
import sourceMapSupport from "source-map-support"
|
||||||
sourceMapSupport.install(options)
|
sourceMapSupport.install(options)
|
||||||
import cfg from "../quartz.config"
|
import cfg from "../quartz.config"
|
||||||
import { Argv, BuildCtx } from "./util/ctx"
|
import { BuildCtx, WorkerSerializableBuildCtx } from "./util/ctx"
|
||||||
import { FilePath, FullSlug } from "./util/path"
|
import { FilePath } from "./util/path"
|
||||||
import {
|
import {
|
||||||
createFileParser,
|
createFileParser,
|
||||||
createHtmlProcessor,
|
createHtmlProcessor,
|
||||||
@@ -14,35 +14,24 @@ import { MarkdownContent, ProcessedContent } from "./plugins/vfile"
|
|||||||
|
|
||||||
// only called from worker thread
|
// only called from worker thread
|
||||||
export async function parseMarkdown(
|
export async function parseMarkdown(
|
||||||
buildId: string,
|
partialCtx: WorkerSerializableBuildCtx,
|
||||||
argv: Argv,
|
|
||||||
fps: FilePath[],
|
fps: FilePath[],
|
||||||
): Promise<[MarkdownContent[], FullSlug[]]> {
|
): Promise<MarkdownContent[]> {
|
||||||
// this is a hack
|
|
||||||
// we assume markdown parsers can add to `allSlugs`,
|
|
||||||
// but don't actually use them
|
|
||||||
const allSlugs: FullSlug[] = []
|
|
||||||
const ctx: BuildCtx = {
|
const ctx: BuildCtx = {
|
||||||
buildId,
|
...partialCtx,
|
||||||
cfg,
|
cfg,
|
||||||
argv,
|
|
||||||
allSlugs,
|
|
||||||
}
|
}
|
||||||
return [await createFileParser(ctx, fps)(createMdProcessor(ctx)), allSlugs]
|
return await createFileParser(ctx, fps)(createMdProcessor(ctx))
|
||||||
}
|
}
|
||||||
|
|
||||||
// only called from worker thread
|
// only called from worker thread
|
||||||
export function processHtml(
|
export function processHtml(
|
||||||
buildId: string,
|
partialCtx: WorkerSerializableBuildCtx,
|
||||||
argv: Argv,
|
|
||||||
mds: MarkdownContent[],
|
mds: MarkdownContent[],
|
||||||
allSlugs: FullSlug[],
|
|
||||||
): Promise<ProcessedContent[]> {
|
): Promise<ProcessedContent[]> {
|
||||||
const ctx: BuildCtx = {
|
const ctx: BuildCtx = {
|
||||||
buildId,
|
...partialCtx,
|
||||||
cfg,
|
cfg,
|
||||||
argv,
|
|
||||||
allSlugs,
|
|
||||||
}
|
}
|
||||||
return createMarkdownParser(ctx, mds)(createHtmlProcessor(ctx))
|
return createMarkdownParser(ctx, mds)(createHtmlProcessor(ctx))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,6 +11,8 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"allowSyntheticDefaultImports": true,
|
"allowSyntheticDefaultImports": true,
|
||||||
"forceConsistentCasingInFileNames": true,
|
"forceConsistentCasingInFileNames": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"jsx": "react-jsx",
|
"jsx": "react-jsx",
|
||||||
"jsxImportSource": "preact"
|
"jsxImportSource": "preact"
|
||||||
|
|||||||
Reference in New Issue
Block a user