Docs

XyperCode · May 4, 2024 · 3adaf16 · 3adaf16
1 parent 2b4b731
commit 3adaf16
Show file tree

Hide file tree

Showing 53 changed files with 98 additions and 0 deletions.
diff --git a/docs/assets/icon.png b/docs/assets/icon.png
diff --git a/docs/assets/light-off.svg b/docs/assets/light-off.svg
diff --git a/docs/assets/light-on.svg b/docs/assets/light-on.svg
diff --git a/docs/assets/search.svg b/docs/assets/search.svg
diff --git a/docs/classes.html b/docs/classes.html
diff --git a/docs/conditions.html b/docs/conditions.html
diff --git a/docs/css/styles.css b/docs/css/styles.css
diff --git a/docs/docs.html b/docs/docs.html
diff --git a/docs/docs.json b/docs/docs.json
diff --git a/docs/effects.html b/docs/effects.html
diff --git a/docs/events.html b/docs/events.html
diff --git a/docs/expressions.html b/docs/expressions.html
diff --git a/docs/functions.html b/docs/functions.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/js/functions.js b/docs/js/functions.js
diff --git a/docs/js/main.js b/docs/js/main.js
diff --git a/docs/js/theme-switcher.js b/docs/js/theme-switcher.js
diff --git a/docs/sections.html b/docs/sections.html
diff --git a/docs/structures.html b/docs/structures.html
diff --git a/docs/templates/README.md b/docs/templates/README.md
@@ -0,0 +1,22 @@
+# Skript Documentation Templates
+
+When generating final result, each HTML file is surrounded by template.html,
+which provides head element, navigation bar and so on.
+
+## Template Patterns
+
+Patterns have syntax of ${pattern_here}. For example, ${skript.version} is replaced with
+current Skript version. Please see below for more...
+
+You can also include other files by using ${include <filename>}. Just please make
+sure that those included files don't have tags which are not allowed in position
+where include is called.
+
+## Pattern Reference
+```
+skript.* - Information of Skript
+version - Skript's version
+include <filename> - Load given file and place them here
+generate <expressions/effects/events/types/functions> <loop template file> - Generated reference
+content - In template.html, marks the point where other file is placed
+```
diff --git a/docs/templates/assets/Logo/Skript Logo Circular.png b/docs/templates/assets/Logo/Skript Logo Circular.png
diff --git a/docs/templates/assets/Logo/Skript Logo.jpg b/docs/templates/assets/Logo/Skript Logo.jpg
diff --git a/docs/templates/assets/Logo/Skript Logo.png b/docs/templates/assets/Logo/Skript Logo.png
diff --git a/docs/templates/assets/icon.png b/docs/templates/assets/icon.png
diff --git a/docs/templates/assets/light-off.svg b/docs/templates/assets/light-off.svg
diff --git a/docs/templates/assets/light-on.svg b/docs/templates/assets/light-on.svg
diff --git a/docs/templates/assets/search.svg b/docs/templates/assets/search.svg
diff --git a/docs/templates/classes.html b/docs/templates/classes.html
@@ -0,0 +1,5 @@
+<h1 id="nav-title">Types</h1>
+
+<div id="content">
+  ${generate classes desc_full.html}
+</div>
diff --git a/docs/templates/conditions.html b/docs/templates/conditions.html
diff --git a/docs/templates/css/styles.css b/docs/templates/css/styles.css
diff --git a/docs/templates/docs.html b/docs/templates/docs.html
diff --git a/docs/templates/docs.json b/docs/templates/docs.json
diff --git a/docs/templates/effects.html b/docs/templates/effects.html
diff --git a/docs/templates/events.html b/docs/templates/events.html
diff --git a/docs/templates/expressions.html b/docs/templates/expressions.html
diff --git a/docs/templates/functions.html b/docs/templates/functions.html
diff --git a/docs/templates/index.html b/docs/templates/index.html
@@ -0,0 +1,65 @@
+<h1 id="nav-title">Documentation</h1>
+
+<div id="content-no-docs" class="no-left-panel" style="display: inline-block;">
+<div style="height: 32px;"></div> <!-- Space -->
+<p> <span style="font-size: 60px; font-weight: bold;">Skript</span> is (surprise, surprise) a scripting plugin for the Bukkit platform. It is easy to use for
+    simple tasks, but you can also create really complex things with it. The syntax of Skript is close to
+    English, but it is still not magic. While you might succeed with experimentation for simple tasks, for
+    anything more complex you will need some guidance. </p>
+<p> This is Skript's documentation. You will find all supported features of the plugin here, along with some
+    useful examples. We don't have tutorials yet, but you can find good ones using whatever search engine you
+    prefer. </p>
+
+<p class="box-title">Quick Look</p>
+<pre class="box code" style="height: 460px; overflow: auto;"><code class="bash">
+command /sethome:<br/>
+	permission: skript.home # Permission required for this command<br/>
+	description: Set your home # Description of this command<br/>
+	executable by: players # Console won't be able to run this command<br/>
+	trigger: # The actual trigger/code that will run when someone do /sethome<br/>
+		# Set a unique variable to sender's location<br/>
+		set {home::%uuid of player%} to location of player<br/>
+		# Send a message to the sender<br/>
+		message &quot;Set your home to &lt;grey&gt;%location of player%&lt;reset&gt;&quot;<br/>
+<br/>
+command /home:<br/>
+	permission: skript.home<br/>
+	description: Teleport yourself to your home<br/>
+	trigger:<br/>
+		# Check if that variable we used in /sethome has been set (in other words, if player ever ran /sethome)<br/>
+		if {home::%uuid of player%} is not set:<br/>
+			message &quot;You have not set your home yet!&quot;<br/>
+			stop trigger # stop the code here, lines below won't run<br/>
+		# Teleport the player to their home<br/>
+		teleport player to {home::%uuid of player%}<br/>
+		send &quot;&amp;aYou have been teleported.&quot;<br/>
+</code></pre>
+
+<div id="info" class="grid-container padding">
+    <div class="grid-item">
+        <p class="box-title">Latest Stable Version</p>
+        <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/releases/tag/${stable-version}" target="_blank">Skript ${stable-version}</a></p>
+    </div>
+    <div class="grid-item">
+        <p class="box-title">Latest Version</p>
+        <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/releases/tag/${latest-version}" target="_blank">Skript ${latest-version}</a></p>
+    </div>
+    <div class="grid-item">
+        <p class="box-title">Contributors</p>
+        <p class="box placeholder"><a class="link" href="https://github.com/SkriptLang/Skript/graphs/contributors" target="_blank">${contributors-size} Contributors</a></p>
+    </div>
+</div>
+
+<p class="box"> Found something incorrect in this documentation? Please report it to the <a
+        href="https://github.com/SkriptLang/skript-docs/issues/">issue tracker</a>. </p>
+<p class="box"> <strong>We are looking for docs authors!</strong> Currently, the only documentation is generated
+    automatically. It would be nice to have some hand-written content such as tutorials on the docs as well. For
+    example, currently we don't have a tutorial on how to use loops here; This makes it harder for newcomers to
+    learn. Check <a href="https://github.com/SkriptLang/skript-docs/issues/12">this issue</a> for more details and
+    if you're interested in helping out. </p>
+
+
+<div style="padding-top: 64px;"></div> <!-- Space -->
+<p style="font-size: 14px; text-align: center;" class="placeholder"><a href="https://github.com/SkriptLang/skript-docs">Documentation Repo</a> •
+    Site developed by <a href="https://github.com/AyhamAl-Ali">Ayham Al-Ali</a> • Site Version <b>${site-version}</b> • Generated on <b>${skript.build.date}</b></p>
+<div style="padding-top: 16px;"></div> <!-- Space -->
diff --git a/docs/templates/js/functions.js b/docs/templates/js/functions.js
diff --git a/docs/templates/js/main.js b/docs/templates/js/main.js
diff --git a/docs/templates/js/theme-switcher.js b/docs/templates/js/theme-switcher.js
diff --git a/docs/templates/sections.html b/docs/templates/sections.html
diff --git a/docs/templates/structures.html b/docs/templates/structures.html
@@ -0,0 +1,6 @@
+<h1 id="nav-title">Structures</h1>
+
+<div id="content">
+
+  ${generate structures desc_full.html}
+</div>
diff --git a/docs/templates/template.html b/docs/templates/template.html
diff --git a/docs/templates/templates/desc_full.html b/docs/templates/templates/desc_full.html
diff --git a/docs/templates/templates/desc_full.json b/docs/templates/templates/desc_full.json
diff --git a/docs/templates/templates/desc_nav.html b/docs/templates/templates/desc_nav.html
diff --git a/docs/templates/templates/navbar.html b/docs/templates/templates/navbar.html
diff --git a/docs/templates/templates/pattern_element.html b/docs/templates/templates/pattern_element.html
diff --git a/docs/templates/templates/pattern_element.json b/docs/templates/templates/pattern_element.json
diff --git a/docs/templates/text.html b/docs/templates/text.html
diff --git a/docs/templates/tutorials.html b/docs/templates/tutorials.html
diff --git a/docs/text.html b/docs/text.html
diff --git a/docs/tutorials.html b/docs/tutorials.html