Merge pull request #70 from smplrspace/next

fix deadlinks

docs/api-reference/queryclient/doors-windows.md

@@ -67,7 +67,7 @@ smplrClient.getDoorsOnLevel({
 ```
 
 - `spaceId` - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
-- `levelIndex` - zero-based index of the level. Refer to the [Opening interface](#Opening-interface) to learn more.
+- `levelIndex` - zero-based index of the level. Refer to the [Opening interface](#opening-interface) to learn more.
 - `Opening` - this main interface is described [here](#opening-interface).
 
 ## getDoorsOnLevelFromCache
@@ -116,7 +116,7 @@ smplrClient.getWindowsOnLevel({
 ```
 
 - `spaceId` - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
-- `levelIndex` - zero-based index of the level. Refer to the [Opening interface](#Opening-interface) to learn more.
+- `levelIndex` - zero-based index of the level. Refer to the [Opening interface](#opening-interface) to learn more.
 - `Opening` - this main interface is described [here](#opening-interface).
 
 ## getWindowsOnLevelFromCache

docs/api-reference/space/space.md

@@ -50,7 +50,7 @@ space.startViewer({
 }) => Promise<void>
 ```
 
-- `preview` - _optional_ - starts by a preview image with a play button similar to YouTube embed. It is advisable to use [our ESM bundle](/#esm-bundle-supports-runtime-tree-shaking) to ensure a quick initial render. _Default value: false_.
+- `preview` - _optional_ - starts by a preview image with a play button similar to YouTube embed. It is advisable to use [our ESM bundle](/#umd-vs-esm-bundles--tree-shaking) to ensure a quick initial render. _Default value: false_.
 - `loadingMessage` - _optional_ - lets you override the text displayed while the space is loading. _Default value: "Loading your space"_.
 - `renderingMessage` - _optional_ - lets you override the text displayed when the space is loaded but still rendering. _Default value: same as loadingMessage_.
 - `mode` - _optional_ - lets you choose between 2D and 3D rendering. _Default value: 3d_.

package.json

@@ -4,14 +4,15 @@
   "scripts": {
     "docusaurus": "docusaurus",
     "start": "BROWSER='Google Chrome Dev' docusaurus start",
-    "build": "docusaurus build",
+    "build": "docusaurus build && yarn check-deadlinks",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "format": "prettier-eslint --write \"src/**/*.{js,json,css}\""
+    "format": "prettier-eslint --write \"src/**/*.{js,json,css}\"",
+    "check-deadlinks": "yarn hyperlink build/ --check-anchors --sources docs/"
   },
   "lint-staged": {
     "linters": {
@@ -48,6 +49,7 @@
   },
   "devDependencies": {
     "@types/react": "^18.2.62",
+    "@untitaker/hyperlink": "^0.1.32",
     "babel-eslint": "^10.1.0",
     "eslint": "^5.16.0",
     "eslint-config-standard": "^12.0.0",

yarn.lock

@@ -2051,6 +2051,11 @@
     lodash.unescape "4.0.1"
     semver "5.5.0"
 
+"@untitaker/hyperlink@^0.1.32":
+  version "0.1.32"
+  resolved "https://registry.yarnpkg.com/@untitaker/hyperlink/-/hyperlink-0.1.32.tgz#2aa2978615069d4eccd44377ecccd127e37b2f8e"
+  integrity sha512-SuhIK4DQKP4xQ6419mygUH1pl8yBTOHzRy/x5hWMkstW+2Qkjn46U27pNJZqKtiOy+BumoTsKLs8FeAyE/tUMg==
+
 "@webassemblyjs/[email protected]":
   version "1.11.1"
   resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.11.1.tgz#2bfd767eae1a6996f432ff7e8d7fc75679c0b6a7"