chore(docs): add docsify documentation

WipeAir · WipeAir · commit ba9ec1a17013 · 2020-09-12T08:53:21.000+02:00
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,42 @@
+# GraphQL Kotlin Toolkit
+[![GitHub Actions](https://github.com/AurityLab/graphql-kotlin-toolkit/workflows/Gradle/badge.svg)](https://github.com/AurityLab/graphql-kotlin-toolkit/actions)
+[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
+[![Maven Central](https://img.shields.io/maven-central/v/com.auritylab.graphql-kotlin-toolkit/codegen?label=codegen)](https://mvnrepository.com/artifact/com.auritylab.graphql-kotlin-toolkit/codegen)
+[![Maven Central](https://img.shields.io/maven-central/v/com.auritylab.graphql-kotlin-toolkit/spring-boot?label=spring%20boot%20integration)](https://mvnrepository.com/artifact/com.auritylab.graphql-kotlin-toolkit/spring-boot)
+
+A toolkit for GraphQL, specifically for [Kotlin](https://kotlinlang.org/). This toolkit provides some useful tools that are compatible with [graphql-java](https://github.com/graphql-java/graphql-java).
+
+## Code generation
+This tool follows the **schema-first** approach, in which you first write your *schema.graphqls* files and implement the server-side code for it afterwards.
+This code generator additionally creates an interface for each resolver. 
+These can be used to implement each resolver in a clean way. The tool also provides specific parameters for each argument, allowing a more type safe way to access the incoming data.
+This code generator also **supports Kotlin's null safety feature**!
+
+Example resolver:
+```kotlin
+class MutationUpdateUser : GQLMutationUpdateUser {
+    override fun resolve(input: GQLUpdateUserInput, env: GQLMutationUpdateUser.Env): User {
+        TODO("implement your resolver")
+    }
+}
+```
+
+**Getting started [here](docs/codegen/gettings-started.md)!**
+
+
+## Spring Boot integration
+This integration works in a more opinionated way as it provides additional annotations which can be used to register code for various GraphQL types.
+It also comes with a servlet, which handles all GraphQL requests.
+
+**Getting started [here](docs/spring-boot-integration/getting-started.md)!**
+
+
+## Documentation
+* Code generation
+    * [Getting started (Gradle Plugin)](docs/codegen/gettings-started.md)
+    * [Schema configuration](docs/codegen/schema-configuration.md)
+    * [Advanced configuration (Gradle Plugin)](docs/codegen/advanced-configuration.md)
+    * [Code generation with Spring Boot integration](docs/codegen/code-generation-with-spring-boot-integration.md)
+* Spring Boot integration
+    * [Getting started](docs/spring-boot-integration/getting-started.md)
+    * [Annotations](docs/spring-boot-integration/annotations.md)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,9 @@
+* Code generation
+    * [Getting started (Gradle Plugin)](/codegen/gettings-started.md)
+    * [Schema configuration](/codegen/schema-configuration.md)
+    * [Advanced configuration (Gradle Plugin)](/codegen/advanced-configuration.md)
+    * [Code generation with Spring Boot integration](/codegen/code-generation-with-spring-boot-integration.md)
+* Spring Boot integration
+    * [Getting started](/spring-boot-integration/getting-started.md)
+    * [Annotations](/spring-boot-integration/annotations.md)
+
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>GraphQL Kotlin Toolkit</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'GraphQL Kotlin Toolkit',
+      repo: 'https://github.com/AurityLab/graphql-kotlin-toolkit',
+      loadSidebar: true
+    }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-kotlin.min.js"></script>
+</body>
+</html>
