refactor: add comments everywhere

2 years ago · 39aca9159d
parent db2b4830eb
commit 39aca9159d
7 changed files with 17 additions and 1 deletions
--- a/src/app.html
+++ b/src/app.html
@ -1,3 +1,4 @@
+<!-- HTML boilerplate for every page that gets filled with svelte code -->
 <!DOCTYPE html>
 <html lang="en">

--- a/src/routes/+layout.js
+++ b/src/routes/+layout.js
@ -1 +1,2 @@
+// Tells sveltekit to prerender every page so the static adapter in svelte.config.js can do its job
 export const prerender = true;
--- a/src/routes/+layout.svelte
+++ b/src/routes/+layout.svelte
@ -1,8 +1,11 @@
+<!-- Code that applies to every single page -->
+<!-- <slot /> is a placeholder, it gets replaced by the html of the page currently being viewed -->
+
 <script>
    import "@material/web/iconbutton/outlined-icon-button";
    import "@material/web/icon/icon";

-    let navShown =  false;
+    let navShown = false;
 </script>

 <header>
@ -117,6 +120,7 @@
    }

    // Code for everything else
+    // :global() means the css applies to all elements in the output html instead of only applying to elements in this file
    main {
        padding: 2ch;
    }
--- a/src/routes/+page.svelte
+++ b/src/routes/+page.svelte
@ -1,3 +1,6 @@
+<!-- Homepage at / -->
+<!--  -->
+
 <svelte:head>
    <title>Cursed Creations | Home</title>
 </svelte:head>
--- a/src/routes/downloads/+layout.svelte
+++ b/src/routes/downloads/+layout.svelte
@ -1,3 +1,7 @@
+<!-- Code that applies to every page under /downloads -->
+<!-- Refer to src/routes/+layout.svelte for explanation of <slot /> -->
+<!-- The code in that layout file also applies here -->
+
 <slot />

 <style>
--- a/src/routes/downloads/+page.svelte
+++ b/src/routes/downloads/+page.svelte
@ -1,3 +1,5 @@
+<!-- Main downloads page at /downloads -->
+
 <svelte:head>
    <title>Cursed Creations | Mod Downloads</title>
 </svelte:head>
--- a/svelte.config.js
+++ b/svelte.config.js
@ -3,6 +3,7 @@ import preprocess from "svelte-preprocess";

 const config = {
 	kit: {
+		// Tells sveltekit to produce static files to upload to github pages
 		adapter: adapter({
 			pages: "docs",
 			assets: "docs",