Merge pull request melonjs#15 from L1lith/gh-pages

Update README & Styling
hornta · Jul 13, 2022 · de30c45 · de30c45
2 parents 9102604 + fd463f0
commit de30c45
Show file tree

Hide file tree

Showing 20 changed files with 1,199 additions and 869 deletions.
diff --git a/CNAME b/CNAME
diff --git a/README.md b/README.md
@@ -1,8 +1,39 @@
-melonJS
-=======
+# melonJS.org
+
+This is the website for [melon.js](https://melonjs.org/). To see how to edit it, please see [Astro](https://astro.build). Pages and components are built using HTML templates (ending in `.astro`), allowing us to split our website up into different parts. The Astro framework also supports the use of `.scss` and many other handy libraries if necessary.
+
+## How to run the site
+
+To run the website in development mode:
+
+    npm run dev
+
+To publish a new version of the site:
+
+    npm run build
+    git add .
+    git commit -m "Deploy my new feature!"
+    git push
+
+To make the source code look pretty (and enforce consistent styling):
+
+    npm run pretty
+    git add .
+    git commit -m "make the source code prettier"
+    git push
+
+## Directory Layout
+
+| Directory        | Purpose                                                                             |
+| :--------------- | :---------------------------------------------------------------------------------- |
+| /public/         | Static Assets                                                                       |
+| /src/pages/      | Pages (routing based on file path, we can also put MD files in here!)               |
+| /src/components/ | Components (little HTML pieces we can re-use across the site, like the site header) |
+| /src/layout/     | Re-usable layouts we can use on any page we want.                                   |
+| /src/styles/     | Where all of the styles are stored (except inline ones)                             |
+
+***
 
-A fresh & lightweight HTML5 game engine
--------------------------------------------------------------------------------
 ![melonJS](http://melonjs.org/media/alex4-github.png)
 
 Copyright (C) 2011 - 2022, AltByte Pte Ltd

diff --git a/docs/assets/4d5b4ae0.bf76871b.css b/docs/assets/4d5b4ae0.bf76871b.css
diff --git a/docs/assets/f0efa161.fdada72a.css b/docs/assets/f0efa161.fdada72a.css
diff --git a/docs/docs/index.html b/docs/docs/index.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <head>
-  <script type="text/javascript">
-    window.location = "http://melonjs.github.io/melonJS/docs/";
-  </script>
+    <script type="text/javascript">
+        window.location = 'http://melonjs.github.io/melonJS/docs/'
+    </script>
 </head>
diff --git a/docs/img/discord.svg b/docs/img/discord.svg
diff --git a/docs/img/github.svg b/docs/img/github.svg
diff --git a/docs/img/logo.svg b/docs/img/logo.svg