From e82ba97a396e4e9d77486b48e6ee8b1dfd1c1b4c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 24 Jul 2023 07:07:58 +0000
Subject: [PATCH] actually add processed tag to frontmatter
---
quartz/plugins/transformers/frontmatter.ts | 75 ++++++++++++++++++++++---------------
1 files changed, 44 insertions(+), 31 deletions(-)
diff --git a/quartz/plugins/transformers/frontmatter.ts b/quartz/plugins/transformers/frontmatter.ts
index 778faac..29b0b4b 100644
--- a/quartz/plugins/transformers/frontmatter.ts
+++ b/quartz/plugins/transformers/frontmatter.ts
@@ -1,51 +1,64 @@
-import { PluggableList } from "unified"
import matter from "gray-matter"
-import remarkFrontmatter from 'remark-frontmatter'
+import remarkFrontmatter from "remark-frontmatter"
import { QuartzTransformerPlugin } from "../types"
+import yaml from "js-yaml"
+import { slug as slugAnchor } from "github-slugger"
export interface Options {
- language: 'yaml' | 'toml',
+ language: "yaml" | "toml"
delims: string | string[]
}
const defaultOptions: Options = {
- language: 'yaml',
- delims: '---'
+ language: "yaml",
+ delims: "---",
}
-export class FrontMatter extends QuartzTransformerPlugin {
- name = "FrontMatter"
- opts: Options
+export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+ const opts = { ...defaultOptions, ...userOpts }
+ return {
+ name: "FrontMatter",
+ markdownPlugins() {
+ return [
+ remarkFrontmatter,
+ () => {
+ return (_, file) => {
+ const { data } = matter(file.value, {
+ ...opts,
+ engines: {
+ yaml: (s) => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object,
+ },
+ })
- constructor(opts?: Options) {
- super()
- this.opts = { ...defaultOptions, ...opts }
- }
+ // tag is an alias for tags
+ if (data.tag) {
+ data.tags = data.tag
+ }
- markdownPlugins(): PluggableList {
- return [
- remarkFrontmatter,
- () => {
- return (_, file) => {
- const { data } = matter(file.value, this.opts)
+ if (data.tags && !Array.isArray(data.tags)) {
+ data.tags = data.tags
+ .toString()
+ .split(",")
+ .map((tag: string) => tag.trim())
+ }
- // fill in frontmatter
- file.data.frontmatter = {
- title: file.stem ?? "Untitled",
- tags: [],
- ...data
+ // slug them all!!
+ data.tags = data.tags?.map((tag: string) => slugAnchor(tag)) ?? []
+
+ // fill in frontmatter
+ file.data.frontmatter = {
+ title: file.stem ?? "Untitled",
+ tags: [],
+ ...data,
+ }
}
- }
- }
- ]
- }
-
- htmlPlugins(): PluggableList {
- return []
+ },
+ ]
+ },
}
}
-declare module 'vfile' {
+declare module "vfile" {
interface DataMap {
frontmatter: { [key: string]: any } & {
title: string
--
Gitblit v1.10.0