docs + various polish

Jacky Zhao

2023-07-10 08f8e3b4a4879dd7c91c16fbce80c4f2bc5e357f

 quartz/path.ts

@@ -1,30 +1,54 @@
import path from 'path'
import { slug as slugAnchor } from 'github-slugger'

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 {
  const [fp, anchor] = s.split("#", 2)
  const sluggedAnchor = anchor === undefined ? "" : "#" + slugSegment(anchor)
  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(/index$/, '')
    .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 fp
  return "./" + fp
    .split('/')
    .filter(x => x !== '')
    .map(_ => '..')