diff --git a/assets/Files/extract1.png b/assets/Files/extract1.png
new file mode 100644
index 0000000..986b9ee
Binary files /dev/null and b/assets/Files/extract1.png differ
diff --git a/assets/Files/github1.png b/assets/Files/github1.png
new file mode 100644
index 0000000..f0aca0b
Binary files /dev/null and b/assets/Files/github1.png differ
diff --git a/assets/Files/makesure1.png b/assets/Files/makesure1.png
new file mode 100644
index 0000000..4f4bd95
Binary files /dev/null and b/assets/Files/makesure1.png differ
diff --git a/assets/Files/npmi1.png b/assets/Files/npmi1.png
new file mode 100644
index 0000000..733a9a2
Binary files /dev/null and b/assets/Files/npmi1.png differ
diff --git a/assets/Files/terminal1.png b/assets/Files/terminal1.png
new file mode 100644
index 0000000..fcadfcd
Binary files /dev/null and b/assets/Files/terminal1.png differ
diff --git a/assets/system/main.css b/assets/system/main.css
index f8b70ad..4daacd3 100644
--- a/assets/system/main.css
+++ b/assets/system/main.css
@@ -186,8 +186,8 @@ body {
box-sizing: border-box;
font-family: var(--font-families);
font-size: 18px;
- border: 2px var(--general-fg) solid;
- background-color: var(--general-bg);
+ border: 2px var(--tag-fg) solid;
+ background-color: var(--main-fg);
color: var(--tag-fg);
border-radius: 8px 0 0 8px;
}
@@ -211,8 +211,8 @@ body {
box-sizing: border-box;
font-family: var(--font-families);
font-size: 18px;
- border: 2px var(--general-fg) solid;
- background-color: var(--general-bg);
+ border: 2px var(--tag-fg) solid;
+ background-color: var(--main-fg);
color: var(--tag-fg);
border-radius: 8px 0 0 8px;
position: absolute;
@@ -227,9 +227,9 @@ body {
box-sizing: border-box;
font-size: 18px;
border-radius: 0 8px 8px 0;
- color: var(--general-bg);
- background-color: var(--general-bg);
- border: 2px var(--general-fg) solid;
+ color: var(--main-fg);
+ border: 2px var(--tag-fg) solid;
+ background-color: var(--main-fg);
position: absolute;
right: 8px;
cursor: default;
@@ -246,7 +246,7 @@ body {
}
#sbheader input::placeholder {
- color: var(--general-fg);
+ color: var(--secondary);
}
.menubutton {
@@ -295,11 +295,17 @@ body {
margin-top: 8px;
}
}
+.showonmobile {
+ display: none;
+}
@media only screen and (max-width: 800px) {
.hideonmobile {
display: none;
}
+ .showonmobile {
+ display: initial;
+ }
#sidebar {
width: 100vw !important;
diff --git a/assets/system/page.css b/assets/system/page.css
index 4463462..d57f77f 100644
--- a/assets/system/page.css
+++ b/assets/system/page.css
@@ -17,15 +17,20 @@
margin: 16px 0;
}
#page p {
+ display: inline-block;
font-size: 16px;
width: 100%;
margin: 0;
}
#page small {
+ display: inline-block;
font-size: 12px;
width: 100%;
margin: 0;
}
+#page > small {
+ margin-bottom: 16px;
+}
#page a {
color: var(--main);
}
@@ -33,4 +38,12 @@
background-color: var(--general-bg);
padding: 2px;
border-radius: 4px;
+}
+#page img {
+ display: block;
+ max-width: 100%;
+ max-height: 500px;
+ object-fit: contain;
+ object-position: left;
+ margin-top: 16px;
}
\ No newline at end of file
diff --git a/index.js b/index.js
index c909f56..bcd5903 100644
--- a/index.js
+++ b/index.js
@@ -15,7 +15,7 @@ var getPages = () => {
__pg.tags["Meta"] = templateTag("//","#808080");
__pg.tags["404"] = templateTag("404","#008000");
__pg.tags["500"] = templateTag("500","#FF0080");
- __pg.wikiData.fullName = __pg.wikiData.name.join(" ");
+ __pg.documentationData.fullName = __pg.documentationData.name.join(" ");
pages = __pg;
}
setInterval(getPages, 10000);
@@ -32,10 +32,10 @@ var getPage = (page) => {
return templateIndex(page, pages.pages[page]);
}
-app.get('/', (_,r) => r.redirect("/wiki/Welcome"));
-app.get('/wiki', (_,r) => r.redirect("/wiki/Welcome"));
+app.get('/', (_,r) => r.redirect("/page/Welcome"));
+app.get('/page', (_,r) => r.redirect("/page/Welcome"));
-app.get('/wiki/:page', function(req, res, next) {
+app.get('/page/:page', function(req, res, next) {
var page = getPage(req.params.page);
switch (page.type) {
case "invaildrequest":
diff --git a/package.json b/package.json
index 2e895c0..26b8d33 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "avalon-wiki-engine",
+ "name": "avalon-documentation-engine",
"version": "1.0.0",
"description": "",
"main": "index.js",
diff --git a/views/articles/Installation.ejs b/views/articles/Installation.ejs
index b01e185..97eba54 100644
--- a/views/articles/Installation.ejs
+++ b/views/articles/Installation.ejs
@@ -1,16 +1,37 @@
-Welcome to the AWE installation guide!
-This guide will assist you while installing the Avalon Wiki Engine on a local server.
+Welcome to the ADE installation guide!
+This guide will assist you while installing the Avalon Documentation Engine on a local server.
Make sure you have your 80 port open on this server.
<%- include("blocks/MessageBox.ejs", {
title: "Docker support",
- content: "This guide will not contain resources for installing AWE on Docker. You are purely on your own for that."
+ content: "This guide will not contain resources for installing ADE on Docker. You are purely on your own for that."
}) %>
Installing locally or on a Node server
-If you just want AWE for your local network, or on your own real server.
+If you just want ADE for your local network, or on your own real server.
+Steps
+Step 1 - Downloading the repository from GitHub
+First, go to any folder you would like to keep ADE in.
+Then, go to the GitHub repository for ADE and download the ZIP.
+
+Selecting Code > Download ZIP on the GitHub UI.
+Then, extract the ZIP into the folder.
+
+Dragging the ZIP contents into a folder.
+<%- include("blocks/MessageBox.ejs", {
+ title: "HOLD ON...",
+ content: "Make sure to read the license! This information is important for defining who and what can use the documentation contents.
Alternatively, make a \"License\" article within the Documentation to define your own license for the content.
Instructions on how to do this can be found here.
"
+}) %>
+Step 2 - Install dependencies
+Installing dependencies for the Avalon Documentation Engine is super easy. Simply open a Node terminal in your Documentation folder.
+
+A terminal, which has the documentation as its' current directory.
+Then, type npm install (or npm i) into the terminal.
+
+A terminal, which has the output of the aforementioned npm command.
+package-lock.json and node-modules/ should appear in the directory.
Installing on Replit
-If you want quickly get AWE up and running.
+If you want quickly get ADE up and running.
<%- include("blocks/MessageBox.ejs", {
title: "Cycles required",
- content: "In order to use AWE on Replit, you will have to use Cycles to make your AWE Repl Always On.",
- notice: "2 cycles/day for Always On"
+ content: "In order to use ADE on Replit, you will have to use Cycles to make your ADE Repl Always On.",
+ notice: "2 cycles/day for Always On - recommended amount is 62, for at least a month"
}) %>
\ No newline at end of file
diff --git a/views/articles/Searching.ejs b/views/articles/Searching.ejs
index 96c79b2..d3e53a4 100644
--- a/views/articles/Searching.ejs
+++ b/views/articles/Searching.ejs
@@ -1,4 +1,4 @@
-Searching in the Avalon Wiki Engine is possible.
+Searching in the Avalon Documentation Engine is possible.
Use the searchbar element on the top-left to type text in and look for articles using a filter.
Search methods
Searching by name
diff --git a/views/articles/Welcome.ejs b/views/articles/Welcome.ejs
index 262c8e9..8e7078b 100644
--- a/views/articles/Welcome.ejs
+++ b/views/articles/Welcome.ejs
@@ -1,11 +1,11 @@
<%- include("blocks/MessageBox.ejs", {
title: "Welcome!",
- content: "Welcome to the " + allPages.wikiData.fullName + " development resource!"
+ content: "Welcome to the " + allPages.documentationData.fullName + " development resource!"
}) %>
-<%- allPages.wikiData.fullName %>
-The Avalon Wiki Engine (also known as AWE) is a free and open-source piece of software, that lets site administrators manage content in a simple format.
+<%- allPages.documentationData.fullName %>
+The Avalon Documentation Engine (also known as ADE) is a free and open-source piece of software, that lets site administrators manage content in a simple format.
About
-The Avalon Wiki Engine is a bit tacky, but it functions well, allowing end users to easily navigate content, with fancy tricks like searching - by name or by tags.
+The Avalon Documentation Engine is a bit tacky, but it functions well, allowing end users to easily navigate content, with fancy tricks like searching - by name or by tags.
Formatting is based on individual EJS files - see ejs.co for more info on EJS templating.
Installation and Source
-An installation guide can be found at Installation.
\ No newline at end of file
+An installation guide can be found at Installation.
\ No newline at end of file
diff --git a/views/articles/blocks/LunchBox.ejs b/views/articles/blocks/LunchBox.ejs
index 20a40aa..70643fb 100644
--- a/views/articles/blocks/LunchBox.ejs
+++ b/views/articles/blocks/LunchBox.ejs
@@ -15,7 +15,7 @@ gap:8px;">
<%- locals.pronouns ?? "she/her" %>
<%- locals.birthday ?? "January 1, 1970" %>
<%- locals.gender ?? "Female" %>, <%- locals.preference ?? "Asexual (deceased)" %>
- <%- locals.attribution ?? "John Doe on Wikipedia" %>
+ <%- locals.attribution ?? "John Doe on Documentationpedia" %>
About
diff --git a/views/index.ejs b/views/index.ejs
index af22ff8..72620da 100644
--- a/views/index.ejs
+++ b/views/index.ejs
@@ -17,7 +17,19 @@