From 0998bc355e6425e6b2bdf3d2da7124aa7b63b2a2 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 17 Aug 2023 08:58:11 +0000
Subject: [PATCH] fix rebuild debouncing
---
content/advanced/paths.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 55 insertions(+), 0 deletions(-)
diff --git a/content/advanced/paths.md b/content/advanced/paths.md
index e69de29..68fc181 100644
--- a/content/advanced/paths.md
+++ b/content/advanced/paths.md
@@ -0,0 +1,55 @@
+---
+title: Paths in Quartz
+---
+
+Paths are pretty complex to reason about because, especially for a static site generator, they can come from so many places.
+
+The current browser URL? Technically a path. A full file path to a piece of content? Also a path. What about a slug for a piece of content? Yet another path.
+
+It would be silly to type these all as `string` and call it a day as it's pretty common to accidentally mistake one type of path for another. Unfortunately, TypeScript does not have [nominal types](https://en.wikipedia.org/wiki/Nominal_type_system) for type aliases meaning even if you made custom types of a server-side slug or a client-slug slug, you can still accidentally assign one to another and TypeScript wouldn't catch it.
+
+Luckily, we can mimic nominal typing using [brands](https://www.typescriptlang.org/play#example/nominal-typing).
+
+```typescript
+// instead of
+type ClientSlug = string
+
+// we do
+type ClientSlug = string & { __brand: "client" }
+
+// that way, the following will fail typechecking
+const slug: ClientSlug = "some random slug"
+```
+
+While this prevents most typing mistakes _within_ our nominal typing system (e.g. mistaking a server slug for a client slug), it doesn't prevent us from _accidentally_ mistaking a string for a client slug when we forcibly cast it.
+
+Thus, we still need to be careful when casting from a string to one of these nominal types in the 'entrypoints', illustrated with hexagon shapes in the diagram below.
+
+The following diagram draws the relationships between all the path sources, nominal path types, and what functions in `quartz/path.ts` convert between them.
+
+```mermaid
+graph LR
+ Browser{{Browser}} --> Window{{Window}} & LinkElement{{Link Element}}
+ Window --"getCanonicalSlug()"--> Canonical[Canonical Slug]
+ Window --"getClientSlug()"--> Client[Client Slug]
+ LinkElement --".href"--> Relative[Relative URL]
+ Client --"canonicalizeClient()"--> Canonical
+ Canonical --"pathToRoot()"--> Relative
+ Canonical --"resolveRelative()" --> Relative
+ MD{{Markdown File}} --> FilePath{{File Path}} & Links[Markdown links]
+ Links --"transformLink()"--> Relative
+ FilePath --"slugifyFilePath()"--> Server[Server Slug]
+ Server --> HTML["HTML File"]
+ Server --"canonicalizeServer()"--> Canonical
+ style Canonical stroke-width:4px
+```
+
+Here are the main types of slugs with a rough description of each type of path:
+
+- `ClientSlug`: client-side slug, usually obtained through `window.location`. Contains the protocol (i.e. starts with `https://`)
+- `CanonicalSlug`: should be used whenever you need to refer to the location of a file/note. Shouldn't be a relative path and shouldn't have leading or trailing slashes `/` either. Also shouldn't have `/index` as an ending or a file extension.
+- `RelativeURL`: must start with `.` or `..` to indicate it's a relative URL. Shouldn't have `/index` as an ending or a file extension.
+- `ServerSlug`: cannot be relative and may not have leading or trailing slashes.
+- `FilePath`: a real file path to a file on disk. Cannot be relative and must have a file extension.
+
+To get a clearer picture of how these relate to each other, take a look at the path tests in `quartz/path.test.ts`.
--
Gitblit v1.10.0