ci: init markdown-lint and resolve linter issues

.github/workflows/lint-md.yml

@@ -0,0 +1,27 @@
+name: Lint
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    paths:
+      - "**.md"
+  push:
+    branches:
+      - main
+    paths:
+      - "**.md"
+
+jobs:
+  lint-md:
+    name: Markdown
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      ## detect errors from markdownlint-cli and create annotations for them
+      - uses: xt0rted/markdownlint-problem-matcher@v3
+      - uses: articulate/actions-markdownlint@v1
+        with:
+          config: .markdownlint.yaml
+          ignore: vendor
+          version: 0.39.0

.markdownlint.yaml

@@ -0,0 +1,21 @@
+---
+# Default state for all rules
+default: true
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
+MD013:
+  ## Increase line length from default '80'
+  line_length: 250
+  ## exluce code_blocks from line linter
+  code_blocks: false
+
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
+MD033:
+  allowed_elements:
+  - img
+  - div
+  - br
+  - a
+  - pre
+  - h1
+  - p

README.md

@@ -1,33 +1,35 @@
-## Starter Game Template
+# Starter Game Template
 
 This repository contains a starter World Engine project that you can use as a scaffold for your project.
 
 ## Installing World CLI
 
-To begin your development journey with World Engine, you install 
-[World CLI](https://github.com/Argus-Labs/world-cli) a tool for creating, managing, and deploying World 
-Engine projects. 
+To begin your development journey with World Engine, you install
+[World CLI](https://github.com/Argus-Labs/world-cli) a tool for creating, managing, and deploying World
+Engine projects.
 
 Install the latest world-cli release by running:
 
 ```bash
 curl https://install.world.dev/cli! | bash
 ```
+
 ### Docker
 
-Docker is used to make it easy to run the World Engine stack and its dependencies. If you don't already have Docker 
+Docker is used to make it easy to run the World Engine stack and its dependencies. If you don't already have Docker
 installed, you can find instructions for your platform here:
 
 [Installation instructions for Docker Desktop](https://docs.docker.com/compose/install/#scenario-one-install-docker-desktop)
 
 ## Getting Started
 
-To use this template to start your own project, navigate to the directory where you want your project to live 
+To use this template to start your own project, navigate to the directory where you want your project to live
 and run:
 
 ```bash
 world create
 ```
+
 You will be prompted for a game name. A copy of the starter-game-template will be created in the current directory.
 
 ### Running Development Mode
@@ -40,20 +42,18 @@ To use it, navigate to your project directory and run
 world cardinal dev
 ```
 
-### Running World Engine E2E 
+### Running World Engine E2E
 
 To run the World Engine stack end-to-end (i.e. in production and game engine integration), run:
 
 ```bash
 world cardinal start
 ```
 
-This command will use the `world.toml` config specified in your root project directory to run both World Engine's 
+This command will use the `world.toml` config specified in your root project directory to run both World Engine's
 Cardinal game shard and Nakama relayer (for game engine integration).
 
-Make sure to set `CARDINAL_MODE="production"` in world.toml to run the stack in production mode and obtain the best 
-performance.
-
+Make sure to set `CARDINAL_MODE="production"` in world.toml to run the stack in production mode and obtain the best performance.
 
 ### Cardinal Editor
 
@@ -67,4 +67,4 @@ After you create some entities in your game, it will show up on the Cardinal Edi
 
 ## Developing Your Game
 
-For more details on how to create the game of your dream, visit the [World Engine documentation](https://world.dev) 
+For more details on how to create the game of your dream, visit the [World Engine documentation](https://world.dev)