Merge branch 'v4' of https://github.com/jackyzha0/quartz into live

docs/features/explorer.md

@@ -61,7 +61,7 @@ export class FileNode {
   children: FileNode[]  // children of current node
   name: string  // last part of slug
   displayName: string // what actually should be displayed in the explorer
-  file: QuartzPluginData | null // set if node is a file, see `QuartzPluginData` for more detail
+  file: QuartzPluginData | null // if node is a file, this is the file's metadata. See `QuartzPluginData` for more detail
   depth: number // depth of current node
 
   ... // rest of implementation
@@ -167,6 +167,19 @@ Component.Explorer({
 
 You can customize this by changing the entries of the `omit` set. Simply add all folder or file names you want to remove.
 
+### Remove files by tag
+
+You can access the frontmatter of a file by `node.file?.frontmatter?`. This allows you to filter out files based on their frontmatter, for example by their tags.
+
+```ts title="quartz.layout.ts"
+Component.Explorer({
+  filterFn: (node) => {
+    // exclude files with the tag "explorerexclude"
+    return node.file?.frontmatter?.tags?.includes("explorerexclude") !== true
+  },
+})
+```
+
 ### Show every element in explorer
 
 To override the default filter function that removes the `tags` folder from the explorer, you can set the filter function to `undefined`.

docs/plugins/TagPage.md

@@ -16,5 +16,5 @@ The pages are displayed using the `defaultListPageLayout` in `quartz.layouts.ts`
 ## API
 
 - Category: Emitter
-- Function name: `Plugin.AliasRedirects()`.
+- Function name: `Plugin.TagPage()`.
 - Source: [`quartz/plugins/emitters/tagPage.tsx`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/emitters/tagPage.tsx).

package-lock.json

@@ -14,7 +14,7 @@
         "@napi-rs/simple-git": "0.1.16",
         "async-mutex": "^0.4.1",
         "chalk": "^5.3.0",
-        "chokidar": "^3.5.3",
+        "chokidar": "^3.6.0",
         "cli-spinner": "^0.2.10",
         "d3": "^7.8.5",
         "esbuild-sass-plugin": "^2.16.1",
@@ -32,7 +32,7 @@
         "mdast-util-to-hast": "^13.1.0",
         "mdast-util-to-string": "^4.0.0",
         "micromorph": "^0.4.5",
-        "preact": "^10.19.5",
+        "preact": "^10.19.6",
         "preact-render-to-string": "^6.3.1",
         "pretty-bytes": "^6.1.1",
         "pretty-time": "^1.1.0",
@@ -1344,15 +1344,9 @@
       }
     },
     "node_modules/chokidar": {
-      "version": "3.5.3",
-      "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.5.3.tgz",
-      "integrity": "sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==",
-      "funding": [
-        {
-          "type": "individual",
-          "url": "https://paulmillr.com/funding/"
-        }
-      ],
+      "version": "3.6.0",
+      "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
+      "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==",
       "dependencies": {
         "anymatch": "~3.1.2",
         "braces": "~3.0.2",
@@ -1365,6 +1359,9 @@
       "engines": {
         "node": ">= 8.10.0"
       },
+      "funding": {
+        "url": "https://paulmillr.com/funding/"
+      },
       "optionalDependencies": {
         "fsevents": "~2.3.2"
       }
@@ -4459,9 +4456,9 @@
       }
     },
     "node_modules/preact": {
-      "version": "10.19.5",
-      "resolved": "https://registry.npmjs.org/preact/-/preact-10.19.5.tgz",
-      "integrity": "sha512-OPELkDmSVbKjbFqF9tgvOowiiQ9TmsJljIzXRyNE8nGiis94pwv1siF78rQkAP1Q1738Ce6pellRg/Ns/CtHqQ==",
+      "version": "10.19.6",
+      "resolved": "https://registry.npmjs.org/preact/-/preact-10.19.6.tgz",
+      "integrity": "sha512-gympg+T2Z1fG1unB8NH29yHJwnEaCH37Z32diPDku316OTnRPeMbiRV9kTrfZpocXjdfnWuFUl/Mj4BHaf6gnw==",
       "funding": {
         "type": "opencollective",
         "url": "https://opencollective.com/preact"

package.json

@@ -39,7 +39,7 @@
     "@napi-rs/simple-git": "0.1.16",
     "async-mutex": "^0.4.1",
     "chalk": "^5.3.0",
-    "chokidar": "^3.5.3",
+    "chokidar": "^3.6.0",
     "cli-spinner": "^0.2.10",
     "d3": "^7.8.5",
     "esbuild-sass-plugin": "^2.16.1",
@@ -57,7 +57,7 @@
     "mdast-util-to-hast": "^13.1.0",
     "mdast-util-to-string": "^4.0.0",
     "micromorph": "^0.4.5",
-    "preact": "^10.19.5",
+    "preact": "^10.19.6",
     "preact-render-to-string": "^6.3.1",
     "pretty-bytes": "^6.1.1",
     "pretty-time": "^1.1.0",

quartz/components/pages/404.tsx

@@ -1,7 +1,7 @@
 import { i18n } from "../../i18n"
-import { QuartzComponentConstructor, QuartzComponentProps } from "../types"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
 
-function NotFound({ cfg }: QuartzComponentProps) {
+const NotFound: QuartzComponent = ({ cfg }: QuartzComponentProps) => {
   return (
     <article class="popover-hint">
       <h1>404</h1>

quartz/components/pages/Content.tsx

@@ -1,7 +1,7 @@
 import { htmlToJsx } from "../../util/jsx"
-import { QuartzComponentConstructor, QuartzComponentProps } from "../types"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
 
-function Content({ fileData, tree }: QuartzComponentProps) {
+const Content: QuartzComponent = ({ fileData, tree }: QuartzComponentProps) => {
   const content = htmlToJsx(fileData.filePath!, tree)
   const classes: string[] = fileData.frontmatter?.cssclasses ?? []
   const classString = ["popover-hint", ...classes].join(" ")

quartz/components/pages/FolderContent.tsx

@@ -1,4 +1,4 @@
-import { QuartzComponentConstructor, QuartzComponentProps } from "../types"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
 import path from "path"
 
 import style from "../styles/listPage.scss"
@@ -22,7 +22,7 @@ const defaultOptions: FolderContentOptions = {
 export default ((opts?: Partial<FolderContentOptions>) => {
   const options: FolderContentOptions = { ...defaultOptions, ...opts }
 
-  function FolderContent(props: QuartzComponentProps) {
+  const FolderContent: QuartzComponent = (props: QuartzComponentProps) => {
     const { tree, fileData, allFiles, cfg } = props
     const folderSlug = stripSlashes(simplifySlug(fileData.slug!))
     const allPagesInFolder = allFiles.filter((file) => {

quartz/components/pages/TagContent.tsx

@@ -1,4 +1,4 @@
-import { QuartzComponentConstructor, QuartzComponentProps } from "../types"
+import { QuartzComponent, QuartzComponentConstructor, QuartzComponentProps } from "../types"
 import style from "../styles/listPage.scss"
 import { PageList } from "../PageList"
 import { FullSlug, getAllSegmentPrefixes, simplifySlug } from "../../util/path"
@@ -8,7 +8,7 @@ import { htmlToJsx } from "../../util/jsx"
 import { i18n } from "../../i18n"
 
 const numPages = 10
-function TagContent(props: QuartzComponentProps) {
+const TagContent: QuartzComponent = (props: QuartzComponentProps) => {
   const { tree, fileData, allFiles, cfg } = props
   const slug = fileData.slug
 

quartz/i18n/index.ts

@@ -12,6 +12,7 @@ import uk from "./locales/uk-UA"
 import ru from "./locales/ru-RU"
 import ko from "./locales/ko-KR"
 import zh from "./locales/zh-CN"
+import vi from "./locales/vi-VN"
 
 export const TRANSLATIONS = {
   "en-US": en,
@@ -48,6 +49,7 @@ export const TRANSLATIONS = {
   "ru-RU": ru,
   "ko-KR": ko,
   "zh-CN": zh,
+  "vi-VN": vi,
 } as const
 
 export const defaultTranslation = "en-US"

quartz/i18n/locales/vi-VN.ts

@@ -0,0 +1,83 @@
+import { Translation } from "./definition"
+
+export default {
+  propertyDefaults: {
+    title: "Không có tiêu đề",
+    description: "Không có mô tả được cung cấp",
+  },
+  components: {
+    callout: {
+      note: "Ghi Chú",
+      abstract: "Tóm Tắt",
+      info: "Thông tin",
+      todo: "Cần Làm",
+      tip: "Gợi Ý",
+      success: "Thành Công",
+      question: "Nghi Vấn",
+      warning: "Cảnh Báo",
+      failure: "Thất Bại",
+      danger: "Nguy Hiểm",
+      bug: "Lỗi",
+      example: "Ví Dụ",
+      quote: "Trích Dẫn",
+    },
+    backlinks: {
+      title: "Liên Kết Ngược",
+      noBacklinksFound: "Không có liên kết ngược được tìm thấy",
+    },
+    themeToggle: {
+      lightMode: "Sáng",
+      darkMode: "Tối",
+    },
+    explorer: {
+      title: "Trong bài này",
+    },
+    footer: {
+      createdWith: "Được tạo bởi",
+    },
+    graph: {
+      title: "Biểu Đồ",
+    },
+    recentNotes: {
+      title: "Bài viết gần đây",
+      seeRemainingMore: ({ remaining }) => `Xem ${remaining} thêm →`,
+    },
+    transcludes: {
+      transcludeOf: ({ targetSlug }) => `Bao gồm ${targetSlug}`,
+      linkToOriginal: "Liên Kết Gốc",
+    },
+    search: {
+      title: "Tìm Kiếm",
+      searchBarPlaceholder: "Tìm kiếm thông tin",
+    },
+    tableOfContents: {
+      title: "Bảng Nội Dung",
+    },
+    contentMeta: {
+      readingTime: ({ minutes }) => `đọc ${minutes} phút`,
+    },
+  },
+  pages: {
+    rss: {
+      recentNotes: "Những bài gần đây",
+      lastFewNotes: ({ count }) => `${count} Bài gần đây`,
+    },
+    error: {
+      title: "Không Tìm Thấy",
+      notFound: "Trang này được bảo mật hoặc không tồn tại.",
+    },
+    folderContent: {
+      folder: "Thư Mục",
+      itemsUnderFolder: ({ count }) =>
+        count === 1 ? "1 mục trong thư mục này." : `${count} mục trong thư mục này.`,
+    },
+    tagContent: {
+      tag: "Thẻ",
+      tagIndex: "Thẻ Mục Lục",
+      itemsUnderTag: ({ count }) =>
+        count === 1 ? "1 mục gắn thẻ này." : `${count} mục gắn thẻ này.`,
+      showingFirst: ({ count }) => `Hiển thị trước ${count} thẻ.`,
+      totalTags: ({ count }) => `Tìm thấy ${count} thẻ tổng cộng.`,
+    },
+  },
+} as const satisfies Translation

quartz/plugins/emitters/componentResources.ts

@@ -120,7 +120,7 @@ function addGlobalPageResources(
   } else if (cfg.analytics?.provider === "umami") {
     componentResources.afterDOMLoaded.push(`
       const umamiScript = document.createElement("script")
-      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.async = true
 

quartz/util/theme.ts

@@ -9,6 +9,11 @@ export interface ColorScheme {
   highlight: string
 }
 
+interface Colors {
+  lightMode: ColorScheme
+  darkMode: ColorScheme
+}
+
 export interface Theme {
   typography: {
     header: string
@@ -16,12 +21,11 @@ export interface Theme {
     code: string
   }
   cdnCaching: boolean
-  colors: {
-    lightMode: ColorScheme
-    darkMode: ColorScheme
-  }
+  colors: Colors
 }
 
+export type ThemeKey = keyof Colors
+
 const DEFAULT_SANS_SERIF =
   '-apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif'
 const DEFAULT_MONO = "ui-monospace, SFMono-Regular, SF Mono, Menlo, monospace"