develop docs

Sup2point0 · Sup2point0 · commit 8788a9adf07f · 2025-03-17T14:58:13.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### New
 - All-new CLI for setting up Squarkdown in a project
 - Revamped `squarkup.json` field names to be clearer and less ambiguous
+  - Extensions for asset preprocessing can now be specified
 
 ### Breaking
 - Renamed `shard` to `tag` (should’ve done this way sooner)
diff --git a/docs/README.md b/docs/README.md
@@ -4,3 +4,5 @@
 -->
 
 Welcome to the *Squarkdown* docs, where you can find all you need to know about Squarkdown!
+
+New to Squarkdown? Start with the [walkthrough](walkthrough).
diff --git a/docs/rationale.md b/docs/rationale.md
@@ -1,6 +1,6 @@
 # Rationale
 <!-- #SQUARK live!
-| dest = docs/rationale
+| dest = info/rationale
 | capt = What did I create Squarkdown for?
 -->
 
diff --git a/docs/reference/squark-charm.md b/docs/reference/squark-charm.md
@@ -9,6 +9,8 @@
 
 </div>
 
+The squark charm is an extended squark which should go under the `# h1` title of a page, providing metadata and directives for how Squarkdown should squarkup the page.
+
 
 <br>
 
diff --git a/docs/reference/squarkup-json.md b/docs/reference/squarkup-json.md
@@ -3,8 +3,13 @@
 | dest = docs/reference/squarkup-json
 -->
 
-Text
+<div class="quicklinks" align="center">
 
+[Example](#example)
+
+</div>
+
+`squarkup.json` goes in a `.squarkdown/` directory in your project’s root directory, configuring how Squarkdown should squarkup the repo.
 
 <br>
 
diff --git a/docs/walkthrough/README.md b/docs/walkthrough/README.md
@@ -0,0 +1,13 @@
+# Walkthrough
+<!-- #SQUARK live!
+| dest = docs/walkthrough
+| desc = A full walkthrough on how to use all of Squarkdown’s features.
+-->
+
+Welcome to the Squarkdown walkthrough. For a lightning-quick overview of how it works, check out [quickstart](quickstart.md).
+
+For detailed guidance on Squarkdown’s usage and features, see the below pages. You can read them in any order you like – this is just a recommended reading order.
+
+- [What is Squarkdown?](what-is-squarkdown.md)
+- [Project Requirements](project-requirements.md)
+- [Squarkdown-flavoured Markdown](squarkdown-flavoured-markdown.md)
diff --git a/docs/walkthrough/quickstart.md b/docs/walkthrough/quickstart.md
@@ -1,6 +1,6 @@
 # Using Squarkdown in a SvelteKit project
-<!-- #SQUARK dead!
-| dest = walkthrough
+<!-- #SQUARK live!
+| dest = docs/walkthrough/quickstart
 | capt = A guided walkthrough on how to use Squarkdown in a SvelteKit project
 -->
 
diff --git a/faq.md b/faq.md
@@ -1,6 +1,7 @@
 # FAQ
 <!-- #SQUARK live!
 | dest = info/faq
+| head = Frequently Asked Questions
 -->
 
 ### Why does Squarkdown only work with SvelteKit and MDsveX?
diff --git a/site/src/site.json b/site/src/site.json
@@ -1,6 +1,6 @@
 {
   "meta": {
-    "exported": "2025-03-13",
+    "exported": "2025-03-17",
     "file_count": 19,
     "page_count": 15
   },
@@ -180,7 +180,7 @@
     },
     "docs/reference/squarkup-json.md": {
       "path": "docs/reference/squarkup-json.md",
-      "last_deploy": "2025-03-13 09:23:12 +0000",
+      "last_deploy": "2025-03-17 14:32:36 +0000",
       "slocs": 83,
       "chars": 4569,
       "isIndex": false,
diff --git a/synopsis.md b/synopsis.md
@@ -1,4 +1,8 @@
 # Hacking the Mainframe
+<!-- #SQUARK live!
+| dest = info/synopsis
+| title = Synopsis
+-->
 
 *Stranger Quarkdown* is a successor to *Quarkdown*, one of my favourite projects. I say ‘a’ successor, because firstly it’s not indended to replace Quarkdown, it just satisfies a different purpose – integrating with Svelte/SvelteKit, rather than generating raw static websites – and secondly there ofc might always be other child projects.
 

-Original file line number
+Diff line change
 </div>
 +The squark charm is an extended squark which should go under the `# h1` title of a page, providing metadata and directives for how Squarkdown should squarkup the page.
++
 <br>