add yaml lint action (checks and recommends)

.github/workflows/yaml-format-check.yml

@@ -0,0 +1,15 @@
+name: YAML Lint
+
+on: [push]
+
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run markdownlint
+      uses: nosborn/[email protected]
+      with:
+        files: 'source'
+        ignore_files: 'source/docs/sample.md'
+        config_file: .markdownlint.yaml

.markdownlint.yaml

@@ -0,0 +1,31 @@
+# from - https://github.com/DavidAnson/markdownlint
+# schema - https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+
+# uses default styling of the cli 
+defaults: True
+extends: null
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md
+MD013: False
+  # Number of characters
+  # line_length: 180
+  # Number of characters for headings
+  # heading_line_length: 180
+  # Number of characters for code blocks
+  # code_block_line_length: 180
+  # Include code blocks
+  # code_blocks: true
+  # Include tables
+  # tables: true
+  # Include headings
+  # headings: true
+  # Strict length checking
+  # strict: false
+  # Stern length checking
+  # stern: false
+
+# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md025.md
+MD025: False
+
+# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md036.md
+MD036: False

source/docs/mr-a.md

@@ -35,4 +35,4 @@ Like it's HTML equivalent, `<mr-a>` can be used to wrap other elements, making t
 </mr-a>
 ```
 
-\[example img\]
+\[example img\]

source/docs/mr-app.md

@@ -17,7 +17,7 @@ The `<mr-app>` tag initializes and mr.js app.
 
 ## Definition and Usage
 
-calling `<mr-app>` tag initializes mr.js and manages the render loop, physics engine, and other core features such as lighting and controllers/hand-tracking. 
+calling `<mr-app>` tag initializes mr.js and manages the render loop, physics engine, and other core features such as lighting and controllers/hand-tracking.
 
 The `<mr-app>` tag has three optional attributes:
 
@@ -39,4 +39,4 @@ The `<mr-app>` tag has three optional attributes:
     * default: `5`
 * `debug` - enables various debug features such as physics, stats monitoring
   * default: `true`
-  * note: hold the `=` key to move using arrows keys while in debug mode
+  * note: hold the `=` key to move using arrows keys while in debug mode

source/docs/mr-button.md

@@ -31,4 +31,4 @@ The `<mr-button>`embeds a button in the UI of an `<mr-panel>`.
 
 `<mr-button>` has one optional attribute:
 
-* `onclick`: the function to be called when the button is clicked
+* `onclick`: the function to be called when the button is clicked

source/docs/mr-div.md

@@ -62,4 +62,4 @@ you can then apply CSS
 </mr-div>
 ```
 
-\[example gif\]
+\[example gif\]

source/docs/mr-entity.md

@@ -5,7 +5,7 @@ istag: true
 ---
 # <mr-entity>
 
-`<mr-entity>` is the most fundamental mr.js element. It is an empty entity and contains no default properties of it's own. 
+`<mr-entity>` is the most fundamental mr.js element. It is an empty entity and contains no default properties of it's own.
 
 ## Example
 
@@ -20,4 +20,4 @@ istag: true
 
 ## Definition and Usage
 
-There are endless uses for `<mr-entity>` the simplest of which simplest is to group other elements together, such that they can be moved, rotated, scaled, and otherwise manipulated as a single entity. as shown in the example above.
+There are endless uses for `<mr-entity>` the simplest of which simplest is to group other elements together, such that they can be moved, rotated, scaled, and otherwise manipulated as a single entity. as shown in the example above.

source/docs/mr-img.md

@@ -20,4 +20,4 @@ Images are not technically inserted into a web page; images are linked to web pa
 The `<mr-img>` tag has two required attributes:
 
 * `src` - Specifies the path to the image
-* `alt` - Specifies an alternate text for the image, if the image, for some reason, cannot be displayed, or if the user uses a screen reader.
+* `alt` - Specifies an alternate text for the image, if the image, for some reason, cannot be displayed, or if the user uses a screen reader.

source/docs/mr-light.md

@@ -29,4 +29,4 @@ istag: true
 
 ## Shadows
 
-for performance reasons, `<mr-light>` cannot cast shadows. Please use the global lighting for shadows.
+for performance reasons, `<mr-light>` cannot cast shadows. Please use the global lighting for shadows.

source/docs/mr-model.md

@@ -27,4 +27,4 @@ istag: true
 * STL
 * OBJ
 * USDZ
-* ?
+* ?

source/docs/mr-panel.md

@@ -5,7 +5,7 @@ istag: true
 ---
 # <mr-panel>
 
-The `<mr-panel>` tag creates a 2.5D UI panel. 
+The `<mr-panel>` tag creates a 2.5D UI panel.
 
 **Currently limited to one UI panel per app**
 
@@ -22,7 +22,7 @@ The `<mr-panel>` tag creates a 2.5D UI panel.
 
 ## Definition and Usage
 
-calling `<mr-panel>` tag initializes and manages 2D UI, such as images, text, and buttons. 
+calling `<mr-panel>` tag initializes and manages 2D UI, such as images, text, and buttons.
 
 ```html
 <mr-panel>
@@ -55,4 +55,4 @@ mr.js supports 2.5D UI, adding a bit of depth to buttons, and incorporating 3D c
 </mr-panel>
 ```
 
-\[example gif\]
+\[example gif\]

source/docs/mr-skybox.md

@@ -21,4 +21,4 @@ istag: true
 
 `<mr-skybox>` has one required attribute:
 
-* `src`: the src image file to be applied to the skybox
+* `src`: the src image file to be applied to the skybox

source/docs/mr-text.md

@@ -90,4 +90,4 @@ let material = new THREE.MeshLambertMaterial({ color: 0xffffff,
                                                map: texture });
 
 text.textObj.material = material
-```
+```

source/docs/mr-textarea.md

@@ -21,4 +21,4 @@ The `<mr-textare>` creates a large text input field in the UI of an `<mr-panel>`
 </mr-app>
 ```
 
-\[example img\]
+\[example img\]

source/docs/mr-textfield.md

@@ -37,4 +37,4 @@ The `<mr-textfield>` creates a text input field in the UI of an `<mr-panel>`.
 
 ## Definition and Usage
 
-`<mr-textfield>`Is the simplest way to capture keyboard input, enabling more practical interactions such as form submission or search input, without needing to exit a spatial experience.
+`<mr-textfield>`Is the simplest way to capture keyboard input, enabling more practical interactions such as form submission or search input, without needing to exit a spatial experience.

source/docs/volumetrics.md

@@ -4,6 +4,6 @@ description: "A page about volumetrics?"
 ---
 # Should we have a page about Volumetrics?
 
-```
+```text
 ┐(´ー｀)┌
-```
+```

source/index.md

@@ -11,4 +11,3 @@ list: true
 1. **Open-source and extendable**: Built on top of web standards, you can implement custom elements and contribute to the ecosystem.
 2. **Familiar and powerful**: Looks and feels like existing libraries, but designed from the ground up for mixed-reality. Start with 2D and ease your way into creating 3D content.
 3. **All-in-one**: Asset management, physics, and user interaction come built in, so you can spend less time laying the foundation and more time building your app.
-