Updated Docs (#327)

* Updated Docs * Whitespace
mbround18 · Apr 15, 2021 · 4aaf1dc · 4aaf1dc
1 parent cf70b29
commit 4aaf1dc
Show file tree

Hide file tree

Showing 15 changed files with 392 additions and 324 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,5 @@
+{
+    "default": true,
+    "MD033": false,
+    "MD013": false
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,17 +5,16 @@
 This package includes a make file for easy development.
 You can get use the make file by installing cargo make via `cargo install cargo-make`
 
-
 ### Commands
 
-| Command             | What it does |
-|---------------------|--------------|
-| makers format       | Formats the `http-server` and `odin` |
-| makers clippy       | Builds and runs clippy on `http-server` and `odin` |
-| makers build        | Builds the two projects |
-| makers start:dev    | Formats, Clippy, docker-compose build, and docker-compose up |
-| makers docker:build | Runs docker-compose build for the file `docker-compose.dev.yml` |
-| makers docker:up    | Runs docker-compose up for `docker-compose.dev.yml` | 
+| Command             | What it does                                                                   |
+| ------------------- | ------------------------------------------------------------------------------ |
+| makers format       | Formats the `http-server` and `odin`                                           |
+| makers clippy       | Builds and runs clippy on `http-server` and `odin`                             |
+| makers build        | Builds the two projects                                                        |
+| makers start:dev    | Formats, Clippy, docker-compose build, and docker-compose up                   |
+| makers docker:build | Runs docker-compose build for the file `docker-compose.dev.yml`                |
+| makers docker:up    | Runs docker-compose up for `docker-compose.dev.yml`                            |
 | makers access       | Runs `docker-compose -f docker-compose.dev.yml exec --user steam valheim bash` |
-| makers access:admin | Runs `docker-compose -f docker-compose.dev.yml exec valheim bash` |
-| makers release      | Builds a release binary for `odin` and `http-server` |
+| makers access:admin | Runs `docker-compose -f docker-compose.dev.yml exec valheim bash`              |
+| makers release      | Builds a release binary for `odin` and `http-server`                           |