From d8d3da9181bc9463b513831cce9761833056c5aa Mon Sep 17 00:00:00 2001 From: Sparky <87631423+Sparky983@users.noreply.github.com> Date: Sun, 18 Jun 2023 08:41:30 +1000 Subject: [PATCH] Remove MkDoc (#71) --- docs/.gitignore | 1 - docs/docs/index.md | 116 --------------------------------------------- docs/mkdocs.yml | 29 ------------ 3 files changed, 146 deletions(-) delete mode 100644 docs/.gitignore delete mode 100644 docs/docs/index.md delete mode 100644 docs/mkdocs.yml diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 1320f90e..00000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -site diff --git a/docs/docs/index.md b/docs/docs/index.md deleted file mode 100644 index aa952530..00000000 --- a/docs/docs/index.md +++ /dev/null @@ -1,116 +0,0 @@ -# Vision GUI - -Vision GUI is a minimal GUI API for Paper. - -## Quick Links - -- [API Javadoc](https://repo.sparky983.me/javadoc/snapshots/me/sparky983/vision/vision-api/0.2-SNAPSHOT) -- [Paper Javadoc](https://repo.sparky983.me/javadoc/snapshots/me/sparky983/vision/vision-paper/0.2-SNAPSHOT) - -## Table of Contents - -1. [Quick Start](#quick-start) - 1. [Installation](#installation) - 2. [Hello World GUI](#hello-world-gui) - -## Quick Start - -### Installation - -Add the following to your build configuration: - -=== "Maven" - ```xml - - - me.sparky983.vision - vision-paper - 0.1 - - - - - - sparky983 - https://repo.sparky983.me - - - ``` - -=== "Gradle (Groovy DSL)" - ```groovy - repositories { - maven { url 'https://repo.sparky983.me' } - } - - dependencies { - implementation 'me.sparky983.vision:vision-paper:0.1' - } - ``` - -=== "Gradle (Kotlin DSL)" - - ```kotlin - repositories { - maven("https://repo.sparky983.me") - } - - dependencies { - implementation("me.sparky983.vision:vision-paper:0.1") - } - ``` - -### Hello World GUI - - -First create an instance of the Vision API. - -=== "Java" - ```java - PaperVision vision = PaperVision.create(plugin); - ``` -=== "Kotlin" - ```kotlin - val vision = PaperVision.create(plugin) - ``` - -Then create the GUI: - -=== "Java" - ```java - Gui gui = Gui.gui() - .title(Component.text("Hello World")) - .rows(3) - .button(Slot.of(1, 4), Button.button() - .name(Component.text("Hello World")) - .type(ItemType.STONE) - .onClick((click) -> { - click.clicker().sendMessage(Component.text("Hello World")); - })); - ``` - -=== "Kotlin" - ```kotlin - val gui = Gui.gui() - .title(Component.text("Hello World")) - .rows(3) - .button(Slot.of(1, 4), Button.button() - .name(Component.text("Hello World")) - .type(ItemType.STONE) - .onClick { it.clicker().sendMessage(Component.text("Hello World")) }) - ``` - -This code creates a GUI with a button that when the button clicked sends a "Hello World" message -to the player. - -And finally open the GUI: - -=== "Java" - ```java - vision.open(player, gui); - ``` - -=== "Kotlin" - ```kotlin - vision.open(player, gui) - ``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index 3770511f..00000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1,29 +0,0 @@ -site_name: Vision -site_description: A minimal GUI API for Paper -site_url: https://vision.sparky983.me/ - -repo_name: sparky983/vision-gui -repo_url: https://github.com/sparky983/vision-gui - -theme: - name: material - palette: - scheme: slate - primary: cyan - accent: cyan - features: - - content.code.copy - - content.tabs.link - -markdown_extensions: - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.tabbed: - alternate_style: true - - pymdownx.snippets - - pymdownx.superfences - -nav: - - Vision: index.md