From 08b02a2d96c7615b36d7026a409a6159ee6348c5 Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 14:45:24 -0800 Subject: [PATCH 01/13] add formatter Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 13 ++++++++++ .yamllint | 34 +++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 .github/workflows/yaml-format-check.yml create mode 100644 .yamllint diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml new file mode 100644 index 0000000..ab29b64 --- /dev/null +++ b/.github/workflows/yaml-format-check.yml @@ -0,0 +1,13 @@ +name: YAML Lint + +on: [push, pull_request] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Install yamllint + run: sudo apt-get install yamllint + - name: Lint YAML files + run: find . -name '*.yaml' -exec yamllint {} \; diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..9b6386d --- /dev/null +++ b/.yamllint @@ -0,0 +1,34 @@ +extends: default + +rules: + # Indentation-related rules + indentation: + spaces: 2 # enforce 2-space indentation + indent-sequences: consistent # sequence items should have the same indentation + + # Line length rule (you can adjust the max line length as needed) + line-length: + max: 80 # set max line length to 80 characters + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: false + + # Rules related to trailing spaces + trailing-spaces: enable + + # Ensure files end with a single newline + new-lines: + end-of-file: newline + + # Rules about key ordering + key-ordering: disable # disable key ordering checks + + # Document start and end markers (--- and ...) + document-start: disable + document-end: disable + + # Other rules like comments, empty lines, etc. + comments: disable + empty-lines: disable + + # Truthy values (e.g., enforcing true/false over yes/no) + truthy: enable From e06bb93be724e3d735d223673fb2e16a6e4251be Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 14:47:30 -0800 Subject: [PATCH 02/13] trigger false linter Signed-off-by: Hannah Bollar --- source/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.md b/source/index.md index e2f079c..28e725e 100644 --- a/source/index.md +++ b/source/index.md @@ -2,7 +2,7 @@ title: "MRJS documentation" description: "TODO" preview: "static/opengraph.jpg" -list: true +list: hi --- # `mrjs` documentation From 0d1279e0f3803500fd4e3ec3c702ef4bb551beaa Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 14:49:00 -0800 Subject: [PATCH 03/13] extension fix Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index ab29b64..7e0373f 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -10,4 +10,4 @@ jobs: - name: Install yamllint run: sudo apt-get install yamllint - name: Lint YAML files - run: find . -name '*.yaml' -exec yamllint {} \; + run: find . \( -name '*.yaml' -o -name '*.yml' \) -exec yamllint {} \; From bc68b23553d2e96bd83421c680f52648e90c8b1b Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 14:54:35 -0800 Subject: [PATCH 04/13] try other action Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index 7e0373f..fcb5ae3 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -7,7 +7,13 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - name: Install yamllint - run: sudo apt-get install yamllint - - name: Lint YAML files - run: find . \( -name '*.yaml' -o -name '*.yml' \) -exec yamllint {} \; + - uses: articulate/actions-markdownlint@v1 + with: + files: 'source/**/*.md' + ignore: node_modules + version: 0.28.1 + #config: markdownlint-config.json + #- name: Install yamllint + #run: sudo apt-get install yamllint + #- name: Lint YAML files + #run: find . \( -name '*.yaml' -o -name '*.yml' \) -exec yamllint {} \; From 522dafec8f8bf188ebc19a3bdeae0c2eaa2a50c8 Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 14:57:30 -0800 Subject: [PATCH 05/13] add config file Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 2 +- markdownlint-config.json | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 markdownlint-config.json diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index fcb5ae3..322b237 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -12,7 +12,7 @@ jobs: files: 'source/**/*.md' ignore: node_modules version: 0.28.1 - #config: markdownlint-config.json + config: markdownlint-config.json #- name: Install yamllint #run: sudo apt-get install yamllint #- name: Lint YAML files diff --git a/markdownlint-config.json b/markdownlint-config.json new file mode 100644 index 0000000..e757ae7 --- /dev/null +++ b/markdownlint-config.json @@ -0,0 +1,23 @@ +{ + "extends": "default", + "rules": { + "indentation": { + "spaces": 2, + "indent-sequences": "consistent" + }, + "line-length": { + "allow-non-breakable-words": true, + "allow-non-breakable-inline-mappings": false + }, + "trailing-spaces": "enable", + "new-lines": { + "end-of-file": "newline" + }, + "key-ordering": "disable", + "document-start": "disable", + "document-end": "disable", + "comments": "disable", + "empty-lines": "disable", + "truthy": "enable" + } +} From a7cde4d1dd8038b27e9f7bfdea71c9ad36a025c7 Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:05:30 -0800 Subject: [PATCH 06/13] fix action for samples.md exclusion Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index 322b237..4c2cf79 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -1,19 +1,15 @@ name: YAML Lint -on: [push, pull_request] +on: [push] jobs: - lint: + markdownlint: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: articulate/actions-markdownlint@v1 + - name: Run markdownlint + uses: nosborn/github-action-markdown-cli@v3.3.0 with: - files: 'source/**/*.md' - ignore: node_modules - version: 0.28.1 - config: markdownlint-config.json - #- name: Install yamllint - #run: sudo apt-get install yamllint - #- name: Lint YAML files - #run: find . \( -name '*.yaml' -o -name '*.yml' \) -exec yamllint {} \; + files: 'source' + ignore_files: 'source/docs/sample.md' + config_file: markdownlint-config.json From 683dc079ec63a6f844f9b4e8f53bd39cdbfb8828 Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:07:12 -0800 Subject: [PATCH 07/13] allow longer line length Signed-off-by: Hannah Bollar --- markdownlint-config.json | 1 + 1 file changed, 1 insertion(+) diff --git a/markdownlint-config.json b/markdownlint-config.json index e757ae7..f02e4ea 100644 --- a/markdownlint-config.json +++ b/markdownlint-config.json @@ -6,6 +6,7 @@ "indent-sequences": "consistent" }, "line-length": { + "max": 180, "allow-non-breakable-words": true, "allow-non-breakable-inline-mappings": false }, From d9670e1013efd49686950daf8aa79a48ba749c9b Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:13:47 -0800 Subject: [PATCH 08/13] update for config.yaml Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 2 +- .markdownlint.yaml | 26 +++++++++++++++++++ .yamllint | 34 ------------------------- markdownlint-config.json | 24 ----------------- 4 files changed, 27 insertions(+), 59 deletions(-) create mode 100644 .markdownlint.yaml delete mode 100644 .yamllint delete mode 100644 markdownlint-config.json diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index 4c2cf79..fd18ada 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -12,4 +12,4 @@ jobs: with: files: 'source' ignore_files: 'source/docs/sample.md' - config_file: markdownlint-config.json + config_file: .markdownlint.yaml diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..9225acf --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,26 @@ +// extends: default + +rules: + indentation: + spaces: 2 + indent-sequences: consistent + + line-length: + max: 180 + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: false + + trailing-spaces: enable + + new-lines: + end-of-file: newline + + key-ordering: disable + + document-start: disable + document-end: disable + + comments: disable + empty-lines: disable + + truthy: enable diff --git a/.yamllint b/.yamllint deleted file mode 100644 index 9b6386d..0000000 --- a/.yamllint +++ /dev/null @@ -1,34 +0,0 @@ -extends: default - -rules: - # Indentation-related rules - indentation: - spaces: 2 # enforce 2-space indentation - indent-sequences: consistent # sequence items should have the same indentation - - # Line length rule (you can adjust the max line length as needed) - line-length: - max: 80 # set max line length to 80 characters - allow-non-breakable-words: true - allow-non-breakable-inline-mappings: false - - # Rules related to trailing spaces - trailing-spaces: enable - - # Ensure files end with a single newline - new-lines: - end-of-file: newline - - # Rules about key ordering - key-ordering: disable # disable key ordering checks - - # Document start and end markers (--- and ...) - document-start: disable - document-end: disable - - # Other rules like comments, empty lines, etc. - comments: disable - empty-lines: disable - - # Truthy values (e.g., enforcing true/false over yes/no) - truthy: enable diff --git a/markdownlint-config.json b/markdownlint-config.json deleted file mode 100644 index f02e4ea..0000000 --- a/markdownlint-config.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "extends": "default", - "rules": { - "indentation": { - "spaces": 2, - "indent-sequences": "consistent" - }, - "line-length": { - "max": 180, - "allow-non-breakable-words": true, - "allow-non-breakable-inline-mappings": false - }, - "trailing-spaces": "enable", - "new-lines": { - "end-of-file": "newline" - }, - "key-ordering": "disable", - "document-start": "disable", - "document-end": "disable", - "comments": "disable", - "empty-lines": "disable", - "truthy": "enable" - } -} From fbc25aa3e46fcc9fcb1a1b9426ba47b9f40244c4 Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:15:38 -0800 Subject: [PATCH 09/13] newline fix Signed-off-by: Hannah Bollar --- source/docs/mr-a.md | 2 +- source/docs/mr-app.md | 2 +- source/docs/mr-button.md | 2 +- source/docs/mr-div.md | 2 +- source/docs/mr-entity.md | 2 +- source/docs/mr-img.md | 2 +- source/docs/mr-light.md | 2 +- source/docs/mr-model.md | 2 +- source/docs/mr-panel.md | 2 +- source/docs/mr-skybox.md | 2 +- source/docs/mr-text.md | 2 +- source/docs/mr-textarea.md | 2 +- source/docs/mr-textfield.md | 2 +- source/docs/volumetrics.md | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/source/docs/mr-a.md b/source/docs/mr-a.md index 86b2bf8..384c727 100644 --- a/source/docs/mr-a.md +++ b/source/docs/mr-a.md @@ -35,4 +35,4 @@ Like it's HTML equivalent, `` can be used to wrap other elements, making t ``` -\[example img\] \ No newline at end of file +\[example img\] diff --git a/source/docs/mr-app.md b/source/docs/mr-app.md index 193afd2..a1179c5 100644 --- a/source/docs/mr-app.md +++ b/source/docs/mr-app.md @@ -39,4 +39,4 @@ The `` 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 \ No newline at end of file + * note: hold the `=` key to move using arrows keys while in debug mode diff --git a/source/docs/mr-button.md b/source/docs/mr-button.md index 56d8c31..ef1175b 100644 --- a/source/docs/mr-button.md +++ b/source/docs/mr-button.md @@ -31,4 +31,4 @@ The ``embeds a button in the UI of an ``. `` has one optional attribute: -* `onclick`: the function to be called when the button is clicked \ No newline at end of file +* `onclick`: the function to be called when the button is clicked diff --git a/source/docs/mr-div.md b/source/docs/mr-div.md index 694103a..5a53b57 100644 --- a/source/docs/mr-div.md +++ b/source/docs/mr-div.md @@ -62,4 +62,4 @@ you can then apply CSS ``` -\[example gif\] \ No newline at end of file +\[example gif\] diff --git a/source/docs/mr-entity.md b/source/docs/mr-entity.md index d288668..adf8b03 100644 --- a/source/docs/mr-entity.md +++ b/source/docs/mr-entity.md @@ -20,4 +20,4 @@ istag: true ## Definition and Usage -There are endless uses for `` 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. \ No newline at end of file +There are endless uses for `` 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. diff --git a/source/docs/mr-img.md b/source/docs/mr-img.md index d26ac75..d93cf45 100644 --- a/source/docs/mr-img.md +++ b/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 `` 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. \ No newline at end of file +* `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. diff --git a/source/docs/mr-light.md b/source/docs/mr-light.md index 7475ad6..90b49f6 100644 --- a/source/docs/mr-light.md +++ b/source/docs/mr-light.md @@ -29,4 +29,4 @@ istag: true ## Shadows -for performance reasons, `` cannot cast shadows. Please use the global lighting for shadows. \ No newline at end of file +for performance reasons, `` cannot cast shadows. Please use the global lighting for shadows. diff --git a/source/docs/mr-model.md b/source/docs/mr-model.md index 247d400..289f8d0 100644 --- a/source/docs/mr-model.md +++ b/source/docs/mr-model.md @@ -27,4 +27,4 @@ istag: true * STL * OBJ * USDZ -* ? \ No newline at end of file +* ? diff --git a/source/docs/mr-panel.md b/source/docs/mr-panel.md index 188bf24..a04610d 100644 --- a/source/docs/mr-panel.md +++ b/source/docs/mr-panel.md @@ -55,4 +55,4 @@ mr.js supports 2.5D UI, adding a bit of depth to buttons, and incorporating 3D c ``` -\[example gif\] \ No newline at end of file +\[example gif\] diff --git a/source/docs/mr-skybox.md b/source/docs/mr-skybox.md index 496b2dc..3c5798b 100644 --- a/source/docs/mr-skybox.md +++ b/source/docs/mr-skybox.md @@ -21,4 +21,4 @@ istag: true `` has one required attribute: -* `src`: the src image file to be applied to the skybox \ No newline at end of file +* `src`: the src image file to be applied to the skybox diff --git a/source/docs/mr-text.md b/source/docs/mr-text.md index f3723cc..adfc6db 100644 --- a/source/docs/mr-text.md +++ b/source/docs/mr-text.md @@ -90,4 +90,4 @@ let material = new THREE.MeshLambertMaterial({ color: 0xffffff, map: texture }); text.textObj.material = material -``` \ No newline at end of file +``` diff --git a/source/docs/mr-textarea.md b/source/docs/mr-textarea.md index b7fba74..463e938 100644 --- a/source/docs/mr-textarea.md +++ b/source/docs/mr-textarea.md @@ -21,4 +21,4 @@ The `` creates a large text input field in the UI of an `` ``` -\[example img\] \ No newline at end of file +\[example img\] diff --git a/source/docs/mr-textfield.md b/source/docs/mr-textfield.md index 1e64faf..2ffa73b 100644 --- a/source/docs/mr-textfield.md +++ b/source/docs/mr-textfield.md @@ -37,4 +37,4 @@ The `` creates a text input field in the UI of an ``. ## Definition and Usage -``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. \ No newline at end of file +``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. diff --git a/source/docs/volumetrics.md b/source/docs/volumetrics.md index 4d12e8d..0d0498a 100644 --- a/source/docs/volumetrics.md +++ b/source/docs/volumetrics.md @@ -6,4 +6,4 @@ description: "A page about volumetrics?" ``` ┐(´ー｀)┌ -``` \ No newline at end of file +``` From 0892e37e36125e696c7cf4aff3f41602672e514a Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:39:17 -0800 Subject: [PATCH 10/13] update Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 2 +- .markdownlint.yaml | 64 +++++++++++++++---------- 2 files changed, 39 insertions(+), 27 deletions(-) diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index fd18ada..ddd4ce8 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -12,4 +12,4 @@ jobs: with: files: 'source' ignore_files: 'source/docs/sample.md' - config_file: .markdownlint.yaml + config_file: .markdownlint.yml diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 9225acf..712941e 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,26 +1,38 @@ -// extends: default - -rules: - indentation: - spaces: 2 - indent-sequences: consistent - - line-length: - max: 180 - allow-non-breakable-words: true - allow-non-breakable-inline-mappings: false - - trailing-spaces: enable - - new-lines: - end-of-file: newline - - key-ordering: disable - - document-start: disable - document-end: disable - - comments: disable - empty-lines: disable - - truthy: enable +defaults: True +extends: null +# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md +MD013: + # 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 + +// rules: +// indentation: +// spaces: 2 +// indent-sequences: consistent +// line-length: +// max: 180 +// allow-non-breakable-words: true +// allow-non-breakable-inline-mappings: false +// trailing-spaces: enable +// new-lines: +// end-of-file: newline +// key-ordering: disable +// document-start: disable +// document-end: disable +// comments: disable +// empty-lines: disable +// truthy: enable From a471b64c91197a3495e1a6168f43a55d508cfb5b Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:49:15 -0800 Subject: [PATCH 11/13] update Signed-off-by: Hannah Bollar --- .markdownlint.yaml | 45 ++++++++++++++++---------------------- source/docs/mr-app.md | 2 +- source/docs/mr-entity.md | 2 +- source/docs/mr-panel.md | 4 ++-- source/docs/volumetrics.md | 2 +- source/index.md | 1 - 6 files changed, 24 insertions(+), 32 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 712941e..e6241fe 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,38 +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: +MD013: False # Number of characters - line_length: 180 + # line_length: 180 # Number of characters for headings - heading_line_length: 180 + # heading_line_length: 180 # Number of characters for code blocks - code_block_line_length: 180 + # code_block_line_length: 180 # Include code blocks - code_blocks: true + # code_blocks: true # Include tables - tables: true + # tables: true # Include headings - headings: true + # headings: true # Strict length checking - strict: false + # strict: false # Stern length checking - stern: false + # 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 -// rules: -// indentation: -// spaces: 2 -// indent-sequences: consistent -// line-length: -// max: 180 -// allow-non-breakable-words: true -// allow-non-breakable-inline-mappings: false -// trailing-spaces: enable -// new-lines: -// end-of-file: newline -// key-ordering: disable -// document-start: disable -// document-end: disable -// comments: disable -// empty-lines: disable -// truthy: enable +# 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 diff --git a/source/docs/mr-app.md b/source/docs/mr-app.md index a1179c5..3af8260 100644 --- a/source/docs/mr-app.md +++ b/source/docs/mr-app.md @@ -17,7 +17,7 @@ The `` tag initializes and mr.js app. ## Definition and Usage -calling `` tag initializes mr.js and manages the render loop, physics engine, and other core features such as lighting and controllers/hand-tracking. +calling `` tag initializes mr.js and manages the render loop, physics engine, and other core features such as lighting and controllers/hand-tracking. The `` tag has three optional attributes: diff --git a/source/docs/mr-entity.md b/source/docs/mr-entity.md index adf8b03..acf5e13 100644 --- a/source/docs/mr-entity.md +++ b/source/docs/mr-entity.md @@ -5,7 +5,7 @@ istag: true --- # <mr-entity> -`` is the most fundamental mr.js element. It is an empty entity and contains no default properties of it's own. +`` is the most fundamental mr.js element. It is an empty entity and contains no default properties of it's own. ## Example diff --git a/source/docs/mr-panel.md b/source/docs/mr-panel.md index a04610d..5f1a4c2 100644 --- a/source/docs/mr-panel.md +++ b/source/docs/mr-panel.md @@ -5,7 +5,7 @@ istag: true --- # <mr-panel> -The `` tag creates a 2.5D UI panel. +The `` tag creates a 2.5D UI panel. **Currently limited to one UI panel per app** @@ -22,7 +22,7 @@ The `` tag creates a 2.5D UI panel. ## Definition and Usage -calling `` tag initializes and manages 2D UI, such as images, text, and buttons. +calling `` tag initializes and manages 2D UI, such as images, text, and buttons. ```html diff --git a/source/docs/volumetrics.md b/source/docs/volumetrics.md index 0d0498a..4ab95db 100644 --- a/source/docs/volumetrics.md +++ b/source/docs/volumetrics.md @@ -4,6 +4,6 @@ description: "A page about volumetrics?" --- # Should we have a page about Volumetrics? -``` +```text ┐(´ー｀)┌ ``` diff --git a/source/index.md b/source/index.md index 28e725e..c0cf734 100644 --- a/source/index.md +++ b/source/index.md @@ -11,4 +11,3 @@ list: hi 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. - From be64e6daaae4eb81a1e3250f94c215a7b5e1051d Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:49:30 -0800 Subject: [PATCH 12/13] update Signed-off-by: Hannah Bollar --- .github/workflows/yaml-format-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/yaml-format-check.yml b/.github/workflows/yaml-format-check.yml index ddd4ce8..fd18ada 100644 --- a/.github/workflows/yaml-format-check.yml +++ b/.github/workflows/yaml-format-check.yml @@ -12,4 +12,4 @@ jobs: with: files: 'source' ignore_files: 'source/docs/sample.md' - config_file: .markdownlint.yml + config_file: .markdownlint.yaml From 9d98f1796de84ca38223d936e288100932e43a82 Mon Sep 17 00:00:00 2001 From: Hannah Bollar Date: Tue, 2 Jan 2024 15:51:18 -0800 Subject: [PATCH 13/13] remove typo Signed-off-by: Hannah Bollar --- source/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.md b/source/index.md index c0cf734..7926977 100644 --- a/source/index.md +++ b/source/index.md @@ -2,7 +2,7 @@ title: "MRJS documentation" description: "TODO" preview: "static/opengraph.jpg" -list: hi +list: true --- # `mrjs` documentation