stranger-quarkdown 4.0.0-alpha.2 → 4.0.0-alpha.3

package/README.md

@@ -0,0 +1,48 @@
+# Stranger Quarkdown
+
+Markdown preprocessing automation for Svelte/Kit projects.
+
+Please visit [the GitHub](https://github.com/Sup2point0/stranger-quarkdown#readme) for the full README :]
+
+
+<br>
+
+
+## Quickstart
+
+Run:
+
+```bash
+> npx squarkdown
+```
+
+With extras:
+
+```bash
+> npx squarkdown --assets --fonts
+```
+
+Remind yourself:
+
+```bash
+> npx squarkdown --help
+```
+
+
+<br>
+
+
+## Library
+
+```svelte
+<script lang="ts">
+	import type { PageData } from "stranger-quarkdown";
+
+	import { page } from "$app/state";
+
+	let page_data: PageData<"long"> = $derived(page.data);
+	
+	// if you set `out.shorter-fields = true`:
+	let shorter_page_data: PageData<"short"> = $derived(page.data);
+</script>
+```

package/index.d.ts

@@ -1,7 +1,21 @@
 /**
  * The metadata exported by Squarkdown for a Markdown page, returned from `load()` in `+page.ts`.
+ * 
+ * The generic type parameter describes what format the field names use. `long` means full, clear identifiers like `description` and `last_update_raw`. `short` means more compact identifiers like `desc` and `update_raw`.
+ * 
+ * Which format is used in `+page.ts` and `site-data.json` is configured by `out.shorter-fields` in your squarkup config.
  */
-export interface PageData
+export type PageData<
+	FieldLength extends "long" | "short"
+		= "long" | "short"
+> = (
+	FieldLength extends "long" ?
+	  LongFields
+	: ShortFields
+);
+
+
+interface LongFields
 {
 	/** The unique stable identifier for the page. */
 	shard: string;
@@ -30,3 +44,34 @@ export interface PageData
 	/** Other arbitrary user-provided fields not intrinsic to Squarkdown. */
 	other: Record<string, string[]>;
 }
+
+
+interface ShortFields
+{
+	/** The unique stable identifier for the page. */
+	shard: string;
+
+	/** The location of the original `.md` file this page represents. */
+	filepath: string;
+
+	/** The folder to render this page's `+page.svx` and `+page.ts` to, relative to `out.folder`. */
+	dest:  string;
+
+	/** The flags provided in this page's charm squark, excluding `live!`. */
+	flags: string[];
+
+	title?: string;
+	desc?: string;
+	head?: string;
+	capt?: string;
+
+	tags: string[];
+
+	date?: Date;
+	date_raw?: string;
+	update?: Date;
+	update_raw?:  string;
+	
+	/** Other arbitrary user-provided fields not intrinsic to Squarkdown. */
+	other: Record<string, string[]>;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "stranger-quarkdown",
   "author": "Sup#2.0",
-  "version": "4.0.0-alpha.2",
+  "version": "4.0.0-alpha.3",
   "license": "MIT",
 
   "description": "Markdown preprocessing for SvelteKit projects",
@@ -24,6 +24,7 @@
     "./bin/",
     "index.d.ts",
     "package.json",
+    "README.md",
     "LICENCE"
   ],
   "exports": {