init mkdocs

README.md

@@ -58,7 +58,8 @@ Check out the [examples here](docs/examples.md).
 
 ### More Information
 
-- [Further documentation](docs/documentation.md)
+- [Command Tree](docs/commands.md)
+- [Default Behavior](docs/defaults.md)
 - [Usage examples](docs/examples.md)
 - [Frequently asked questions and nice-to-know facts](docs/faq.md)
 - [Design/Architecture Thoughts, Plans, Unsorted Ideas and more](thoughts.md)

docs/commands.md

@@ -0,0 +1,25 @@
+# Command Tree
+
+```bash
+k3d
+  create
+    cluster CLUSTERNAME
+    node NODENAME
+  delete
+    cluster CLUSTERNAME
+    node
+  start
+    cluster CLUSTERNAME
+    node
+  stop
+    cluster CLUSTERNAME
+    node
+  get
+    cluster CLUSTERNAME
+    node
+    kubeconfig CLUSTERNAME
+  load
+  completion
+  version
+  help
+```

docs/defaults.md

@@ -1,8 +1,4 @@
-# Documentation
-
-## Functionality
-
-### Defaults
+# Defaults
 
 * multiple master nodes
   * by default, when `--master` > 1 and no `--datastore-x` option is set, the first master node (master-0) will be the initializing master node

docs/index.md

@@ -0,0 +1,25 @@
+# k3d
+
+k3d is a lightweight wrapper to run k3s (Rancher Lab's minimal Kubernetes distribution) in docker.
+
+k3d makes it very easy to create single- and multi-node k3s clusters in docker, e.g. for local development on Kubernetes.
+
+## Quick Start
+
+Create a cluster named `mycluster` with just a single master node:
+
+```bash
+k3d create cluster mycluster
+```
+
+Get the new cluster's connection details merged into your default kubeconfig (usually specified using the `KUBECONFIG` environment variable or the default path `$HOME/.kube/config`) and directly switch to the new context:
+
+```bash
+k3d get kubeconfig mycluster --switch
+```
+
+Use the new cluster with [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/), e.g.:
+
+```bash
+kubectl get nodes
+```

mkdocs.yml

@@ -0,0 +1,22 @@
+# Project information
+site_name: k3d
+site_description: Little helper to run Rancher Lab's k3s in Docker
+site_url: https://k3d.io/
+
+copyright: "Copyright © 2020 k3d Authors"
+
+# Repo Information
+repo_url: https://github.com/rancher/k3d
+strict: True
+
+# Theme
+theme: 
+  name: material
+
+# Navigation
+nav:
+  - Overview: index.md
+  - Command Tree: commands.md
+  - Defaults: defaults.md
+  - Examples: examples.md
+  - FAQ: faq.md