From cefbca4753a7d98f93f57a6452a09f6308e2fe27 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 11 Aug 2023 04:16:07 +0000
Subject: [PATCH] docs on making plugins

---
 content/advanced/paths.md |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/content/advanced/paths.md b/content/advanced/paths.md
index 4965119..8e2ac96 100644
--- a/content/advanced/paths.md
+++ b/content/advanced/paths.md
@@ -43,3 +43,11 @@
     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`.
\ No newline at end of file

--
Gitblit v1.10.0