tset1

2022-05-29 13:08:06 +02:00
parent 31d03b5f21
commit 8997f27f4a
3 changed files with 46 additions and 0 deletions
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -0,0 +1,2 @@
+- [Home](/)
+- [Getting Started](/gettingStarted)
--- a/docs/home.md
+++ b/docs/home.md
@@ -0,0 +1,21 @@
+# Welcome to The Basalt Wiki!
+*Note: The Basalt Wiki is a work in progress, now also just migrated away from github wiki. Please treat Wiki errors the same as bugs and report them accordingly.*
+
+Here you can find information about how to use Basalt as well as examples of functional Basalt code. The aim of Basalt is to improve user interaction through visual display.
+
+On the right side of this page you can find a Wiki Navigation, where you can find a more detailed list of Basalt's features
+
+## About Basalt
+
+Basalt is intended to be an easy-to-understand UI Framework designed for CC:Tweaked (AKA Computer Craft: Tweaked) - a popular minecraft mod. For more information about CC:Tweaked, checkout the project's <a href="https://tweaked.cc/">home page</a>.
+
+## Quick Demo
+![Preview](https://media0.giphy.com/media/fvmNPshXKeU7FFA9iA/giphy.gif)
+
+## Questions & Bugs
+
+Obviously NyoriE has implemented some easter eggs, _some people_ call them "bugs". If you happen to discover one of these just make a new <a href="https://github.com/Pyroxenium/Basalt/issues">issue</a>.
+
+Additionally, if you have questions about Basalt or how to make use of it, feel free to create a new discussion on <a href="https://github.com/Pyroxenium/Basalt/discussions">Basalt's Discussion Board</a>.
+
+You may also join the Discord: https://discord.gg/yNNnmBVBpE
--- a/docs/index.html
+++ b/docs/index.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
+  <title>Basalt Docs</title>
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+        name: 'Basalt Docs',
+        repo: 'https://github.com/Pyroxenium/Basalt',
+        loadSidebar: true,
+        auto2top: true,
+        // logo: 'path to logo'
+      };
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>