From 08f8e3b4a4879dd7c91c16fbce80c4f2bc5e357f Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 10 Jul 2023 02:32:24 +0000
Subject: [PATCH] docs + various polish
---
quartz/path.ts | 67 ++++++++++++++++++++++++++++-----
1 files changed, 57 insertions(+), 10 deletions(-)
diff --git a/quartz/path.ts b/quartz/path.ts
index ddad387..0332584 100644
--- a/quartz/path.ts
+++ b/quartz/path.ts
@@ -1,19 +1,66 @@
import path from 'path'
+import { slug as slugAnchor } from 'github-slugger'
-// Replaces all whitespace with dashes and URI encodes the rest
-export function pathToSlug(fp: string): string {
- const { dir, name } = path.parse(fp)
- let slug = path.join('/', dir, name)
- slug = slug.replace(/\s/g, '-')
- return slug
+function slugSegment(s: string): string {
+ return s.replace(/\s/g, '-')
+}
+
+// on the client, 'index' isn't ever rendered so we should clean it up
+export function clientSideSlug(fp: string): string {
+ // remove index
+ if (fp.endsWith("index")) {
+ fp = fp.slice(0, -"index".length)
+ }
+
+ // remove trailing slash
+ if (fp.endsWith("/")) {
+ fp = fp.slice(0, -1)
+ }
+
+ return fp
+}
+
+export function trimPathSuffix(fp: string): string {
+ fp = clientSideSlug(fp)
+ let [cleanPath, anchor] = fp.split("#", 2)
+ anchor = anchor === undefined ? "" : "#" + anchor
+
+ return cleanPath + anchor
+}
+
+export function slugify(s: string): string {
+ let [fp, anchor] = s.split("#", 2)
+ const sluggedAnchor = anchor === undefined ? "" : "#" + slugAnchor(anchor)
+ const withoutFileExt = fp.replace(new RegExp(path.extname(fp) + '$'), '')
+ const rawSlugSegments = withoutFileExt.split(path.sep)
+ const slugParts: string = rawSlugSegments
+ .map((segment) => slugSegment(segment))
+ .join(path.posix.sep)
+ .replace(/\/$/, '')
+ return path.normalize(slugParts) + sluggedAnchor
}
// resolve /a/b/c to ../../
export function resolveToRoot(slug: string): string {
- let fp = slug
- if (fp.endsWith("/index")) {
- fp = fp.slice(0, -"/index".length)
+ let fp = trimPathSuffix(slug)
+
+ if (fp === "") {
+ return "."
}
- return "./" + path.relative(fp, path.posix.sep)
+ return "./" + fp
+ .split('/')
+ .filter(x => x !== '')
+ .map(_ => '..')
+ .join('/')
}
+
+export function relativeToRoot(slug: string, fp: string): string {
+ return path.join(resolveToRoot(slug), fp)
+}
+
+export function relative(src: string, dest: string): string {
+ return path.relative(src, dest)
+}
+
+export const QUARTZ = "quartz"
--
Gitblit v1.10.0