restructuring

2025-11-25 13:24:24 +00:00 · 2023-03-06 16:31:53 +01:00
parent ffc66602b3
commit d1e733e88e
25 changed files with 35 additions and 0 deletions
--- a/website/README.md
+++ b/website/README.md
@@ -0,0 +1,12 @@
+# Website
+The main website's pages are written in HTML & CSS whilst the doc pages are automatically generated by the script in [./build](build/).
+** DO NOT MODIFY THE DOC PAGES IN THE [dist/docs/](dist/docs/) DIRECTORY! **
+
+## Links in the md files in [src/](src/)
+Please note that you are required to use either a link relative to the root folder with double forward slash (example: *//server/app.js*), to the website root with a single forward slash (example: */download*) or a full link (example: *https://myevent.janishutz.com/docs*). If you do not follow these patterns, the website won't build or the links will not work correctly. NOTE: Don't be confused if the root folder links don't work in the Markdown, as they use specific syntax for the build script.
+
+## Folder structure and file naming
+Please create an *index.md* file inside of a folder such that, when the website is compiled, the *.html* file extension disappears.
+
+## Modifying the files in [dist/](dist/)
+You may modify all the files in the [dist/](dist/) directory except the files in [dist/docs/](dist/docs/).
--- a/website/dist/about/index.html
+++ b/website/dist/about/index.html
--- a/website/dist/assets/logo.png
+++ b/website/dist/assets/logo.png
--- a/website/dist/css/home.css
+++ b/website/dist/css/home.css
--- a/website/dist/css/style.css
+++ b/website/dist/css/style.css
--- a/website/dist/docs/index.html
+++ b/website/dist/docs/index.html
--- a/website/dist/docs/js/index.js
+++ b/website/dist/docs/js/index.js
--- a/website/dist/download/index.html
+++ b/website/dist/download/index.html
--- a/website/dist/footer.html
+++ b/website/dist/footer.html
--- a/website/dist/index.html
+++ b/website/dist/index.html
--- a/website/dist/js/index.js
+++ b/website/dist/js/index.js
@@ -0,0 +1,9 @@
+/*
+*				myevent - index.js
+*
+*	Created by Janis Hutz 03/06/2023, Licensed under the GPL V3 License
+*			https://janishutz.com, development@janishutz.com
+*
+*
+*/
+
--- a/website/dist/nav.html
+++ b/website/dist/nav.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>nav</title>
+    </head>
+    <body>
+        
+    </body>
+</html>