From 57cd5697ed3bc590e5fc580e173b1e4d1f1c21cf Mon Sep 17 00:00:00 2001 From: Lukas Runge Date: Mon, 28 Aug 2023 21:31:42 +0200 Subject: [PATCH 1/5] =?UTF-8?q?=E2=9C=A8=F0=9F=93=9A=20added=20initial=20c?= =?UTF-8?q?oncept=20of=20synced=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 + package-lock.json | 73 +++++++++++++++++++ package.json | 2 + src/routes/+page.md | 5 ++ src/routes/+page.svelte | 2 - src/routes/md.css | 3 + src/routes/md.svelte | 31 ++++++++ src/routes/src/routes/visualizer/+page.md | 5 ++ .../src/routes/visualizer/remote/+page.md | 5 ++ src/routes/src/routes/webSocketDemo/+page.md | 5 ++ src/routes/visualizer/README.md | 9 +++ src/routes/visualizer/remote/README.md | 9 +++ src/routes/webSocketDemo/README.md | 9 +++ svelte.config.js | 16 +++- vite.config.ts | 3 + 15 files changed, 178 insertions(+), 3 deletions(-) create mode 100644 src/routes/+page.md delete mode 100644 src/routes/+page.svelte create mode 100644 src/routes/md.css create mode 100644 src/routes/md.svelte create mode 100644 src/routes/src/routes/visualizer/+page.md create mode 100644 src/routes/src/routes/visualizer/remote/+page.md create mode 100644 src/routes/src/routes/webSocketDemo/+page.md create mode 100644 src/routes/visualizer/README.md create mode 100644 src/routes/visualizer/remote/README.md create mode 100644 src/routes/webSocketDemo/README.md diff --git a/README.md b/README.md index e1cd0f7..5ab1df8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +--- +title: Vision +--- + # SHIFTY - Vision A new and intuitive way of controlling intelligent devices developed from first principles for the event industry. diff --git a/package-lock.json b/package-lock.json index 0cbb78f..f0a758c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17,6 +17,7 @@ "fast-xml-parser": "^4.2.7", "fetch-cookie": "^2.1.0", "gdtf-types": "^1.0.0", + "github-markdown-css": "^5.2.0", "json-schema-to-typescript": "^13.0.2", "jszip": "^3.10.1", "three": "^0.155.0", @@ -38,6 +39,7 @@ "eslint": "^8.28.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-svelte": "^2.30.0", + "mdsvex": "^0.11.0", "nodemon": "^3.0.1", "polka": "^0.5.2", "prettier": "^2.8.0", @@ -985,6 +987,12 @@ "integrity": "sha512-XTpWPg/bsGt2oHRmNFfq6kjXDJgeX14pPVFq/PutOe83OFiwrSNP9pV0V2j5O+L/r2XiXRlOZPJtyaOAX5fCBQ==", "dev": true }, + "node_modules/@types/unist": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.7.tgz", + "integrity": "sha512-cputDpIbFgLUaGQn6Vqg3/YsJwxUwHLO13v3i5ouxT4lat0khip9AEWxtERujXV9wxIB1EyF97BSJFt6vpdI8g==", + "dev": true + }, "node_modules/@types/webxr": { "version": "0.5.4", "resolved": "https://registry.npmjs.org/@types/webxr/-/webxr-0.5.4.tgz", @@ -2926,6 +2934,14 @@ "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" } }, + "node_modules/github-markdown-css": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/github-markdown-css/-/github-markdown-css-5.2.0.tgz", + "integrity": "sha512-hq5RaCInSUZ48bImOZpkppW2/MT44StRgsbsZ8YA4vJFwLKB/Vo3k7R2t+pUGqO+ThG0QDMi96TewV/B3vyItg==", + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/glob": { "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", @@ -3638,6 +3654,21 @@ "resolved": "https://registry.npmjs.org/mdn-data/-/mdn-data-2.0.30.tgz", "integrity": "sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==" }, + "node_modules/mdsvex": { + "version": "0.11.0", + "resolved": "https://registry.npmjs.org/mdsvex/-/mdsvex-0.11.0.tgz", + "integrity": "sha512-gJF1s0N2nCmdxcKn8HDn0LKrN8poStqAicp6bBcsKFd/zkUBGLP5e7vnxu+g0pjBbDFOscUyI1mtHz+YK2TCDw==", + "dev": true, + "dependencies": { + "@types/unist": "^2.0.3", + "prism-svelte": "^0.4.7", + "prismjs": "^1.17.1", + "vfile-message": "^2.0.4" + }, + "peerDependencies": { + "svelte": ">=3 <5" + } + }, "node_modules/memoizee": { "version": "0.4.15", "resolved": "https://registry.npmjs.org/memoizee/-/memoizee-0.4.15.tgz", @@ -4363,6 +4394,21 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, + "node_modules/prism-svelte": { + "version": "0.4.7", + "resolved": "https://registry.npmjs.org/prism-svelte/-/prism-svelte-0.4.7.tgz", + "integrity": "sha512-yABh19CYbM24V7aS7TuPYRNMqthxwbvx6FF/Rw920YbyBWO3tnyPIqRMgHuSVsLmuHkkBS1Akyof463FVdkeDQ==", + "dev": true + }, + "node_modules/prismjs": { + "version": "1.29.0", + "resolved": "https://registry.npmjs.org/prismjs/-/prismjs-1.29.0.tgz", + "integrity": "sha512-Kx/1w86q/epKcmte75LNrEoT+lX8pBpavuAbvJWRXar7Hz8jrtF+e3vY751p0R8H9HdArwaCTNDDzHg/ScJK1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", @@ -5819,6 +5865,19 @@ "node": ">=14.0" } }, + "node_modules/unist-util-stringify-position": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-2.0.3.tgz", + "integrity": "sha512-3faScn5I+hy9VleOq/qNbAd6pAx7iH5jYBMS9I1HgQVijz/4mv5Bvw5iw1sC/90CODiKo81G/ps8AJrISn687g==", + "dev": true, + "dependencies": { + "@types/unist": "^2.0.2" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/universalify": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", @@ -5882,6 +5941,20 @@ "node": ">= 0.8" } }, + "node_modules/vfile-message": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-2.0.4.tgz", + "integrity": "sha512-DjssxRGkMvifUOJre00juHoP9DPWuzjxKuMDrhNbk2TdaYYBNMStsNhEOt3idrtI12VQYM/1+iM0KOzXi4pxwQ==", + "dev": true, + "dependencies": { + "@types/unist": "^2.0.0", + "unist-util-stringify-position": "^2.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/vite": { "version": "4.4.9", "resolved": "https://registry.npmjs.org/vite/-/vite-4.4.9.tgz", diff --git a/package.json b/package.json index cf4ec7d..b0fa010 100644 --- a/package.json +++ b/package.json @@ -41,6 +41,7 @@ "eslint": "^8.28.0", "eslint-config-prettier": "^8.5.0", "eslint-plugin-svelte": "^2.30.0", + "mdsvex": "^0.11.0", "nodemon": "^3.0.1", "polka": "^0.5.2", "prettier": "^2.8.0", @@ -63,6 +64,7 @@ "fast-xml-parser": "^4.2.7", "fetch-cookie": "^2.1.0", "gdtf-types": "^1.0.0", + "github-markdown-css": "^5.2.0", "json-schema-to-typescript": "^13.0.2", "jszip": "^3.10.1", "three": "^0.155.0", diff --git a/src/routes/+page.md b/src/routes/+page.md new file mode 100644 index 0000000..d67bd1c --- /dev/null +++ b/src/routes/+page.md @@ -0,0 +1,5 @@ + + + diff --git a/src/routes/+page.svelte b/src/routes/+page.svelte deleted file mode 100644 index ad2a101..0000000 --- a/src/routes/+page.svelte +++ /dev/null @@ -1,2 +0,0 @@ -

Welcome to SvelteKit

-

Visit /webSocketDemo to see if the WebSocket Server works

diff --git a/src/routes/md.css b/src/routes/md.css new file mode 100644 index 0000000..07869fe --- /dev/null +++ b/src/routes/md.css @@ -0,0 +1,3 @@ +body { + background-color: #0d1117; +} diff --git a/src/routes/md.svelte b/src/routes/md.svelte new file mode 100644 index 0000000..b73e8bd --- /dev/null +++ b/src/routes/md.svelte @@ -0,0 +1,31 @@ + + + + {title} | SHIFTY + + +
+ +
+ + diff --git a/src/routes/src/routes/visualizer/+page.md b/src/routes/src/routes/visualizer/+page.md new file mode 100644 index 0000000..6a62803 --- /dev/null +++ b/src/routes/src/routes/visualizer/+page.md @@ -0,0 +1,5 @@ + + + diff --git a/src/routes/src/routes/visualizer/remote/+page.md b/src/routes/src/routes/visualizer/remote/+page.md new file mode 100644 index 0000000..f012acf --- /dev/null +++ b/src/routes/src/routes/visualizer/remote/+page.md @@ -0,0 +1,5 @@ + + + diff --git a/src/routes/src/routes/webSocketDemo/+page.md b/src/routes/src/routes/webSocketDemo/+page.md new file mode 100644 index 0000000..e3caede --- /dev/null +++ b/src/routes/src/routes/webSocketDemo/+page.md @@ -0,0 +1,5 @@ + + + diff --git a/src/routes/visualizer/README.md b/src/routes/visualizer/README.md new file mode 100644 index 0000000..b7d3f22 --- /dev/null +++ b/src/routes/visualizer/README.md @@ -0,0 +1,9 @@ +--- +title: Visualizer +--- + +# Visualizer + +Uses three.js to visualize a fixture. + +[dev server link](/visualizer) diff --git a/src/routes/visualizer/remote/README.md b/src/routes/visualizer/remote/README.md new file mode 100644 index 0000000..752a579 --- /dev/null +++ b/src/routes/visualizer/remote/README.md @@ -0,0 +1,9 @@ +--- +title: Remote +--- + +# Remote + +Controls the visualized fixtures pan and tilt axis. + +[dev server link](/visualizer/remote) diff --git a/src/routes/webSocketDemo/README.md b/src/routes/webSocketDemo/README.md new file mode 100644 index 0000000..7d9e929 --- /dev/null +++ b/src/routes/webSocketDemo/README.md @@ -0,0 +1,9 @@ +--- +title: WebSocket Demo +--- + +# WebSocket Demo + +Shows a basic connection (polling upgraded to websockets) between distributes components. + +[dev server link](/webSocketDemo) diff --git a/svelte.config.js b/svelte.config.js index 2214c60..724af39 100644 --- a/svelte.config.js +++ b/svelte.config.js @@ -1,11 +1,25 @@ import adapter from '@sveltejs/adapter-node'; import { vitePreprocess } from '@sveltejs/kit/vite'; +import { mdsvex } from 'mdsvex'; +import { join, resolve } from 'path'; +import { fileURLToPath } from 'url'; + +const dirname = resolve(fileURLToPath(import.meta.url), '../'); /** @type {import('@sveltejs/kit').Config} */ const config = { + extensions: ['.svelte', '.svx', '.md'], // Consult https://kit.svelte.dev/docs/integrations#preprocessors // for more information about preprocessors - preprocess: vitePreprocess(), + preprocess: [ + vitePreprocess({}), + mdsvex({ + extensions: ['.svx', '.md'], + layout: { + _: join(dirname, './src/routes/md.svelte') + } + }) + ], kit: { // adapter-auto only supports some environments, see https://kit.svelte.dev/docs/adapter-auto for a list. diff --git a/vite.config.ts b/vite.config.ts index dd03cbe..72c0dfe 100644 --- a/vite.config.ts +++ b/vite.config.ts @@ -15,6 +15,9 @@ export default defineConfig({ server: { watch: { ignored: ['**/public/**'] + }, + fs: { + allow: ['./README.md'] } }, plugins: [sveltekit(), webSocketServer], From 6928f08cba23ca384eaf7979f675439490e64a75 Mon Sep 17 00:00:00 2001 From: Lukas Runge Date: Mon, 28 Aug 2023 21:47:26 +0200 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=90=9B=E2=9C=94=EF=B8=8F=20updated=20?= =?UTF-8?q?playwright=20test=20with=20new=20header=20name?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test.ts b/tests/test.ts index 5816be4..5b1d561 100644 --- a/tests/test.ts +++ b/tests/test.ts @@ -2,5 +2,5 @@ import { expect, test } from '@playwright/test'; test('index page has expected h1', async ({ page }) => { await page.goto('/'); - await expect(page.getByRole('heading', { name: 'Welcome to SvelteKit' })).toBeVisible(); + await expect(page.getByRole('heading', { name: 'SHIFTY - Vision' })).toBeVisible(); }); From 88a965ae38fb7ad201e1f576cdb19ce9ac644aee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hannes=20R=C3=BCger?= Date: Sun, 3 Sep 2023 18:23:39 +0200 Subject: [PATCH 3/5] fix: yaml frontmatter in generated html output --- typedoc.json | 1 + 1 file changed, 1 insertion(+) diff --git a/typedoc.json b/typedoc.json index 15f237b..cf40aed 100644 --- a/typedoc.json +++ b/typedoc.json @@ -5,6 +5,7 @@ "tsconfig": "tsconfig.docs.json", // "excludePrivate": true, "plugin": ["@mxssfd/typedoc-theme"], + "stripYamlFrontmatter": true, "theme": "my-theme", "name": "Home", "visibilityFilters": { From 0e4be0a04fd2407879955c2256ec9740ee401b09 Mon Sep 17 00:00:00 2001 From: Lukas Runge Date: Mon, 4 Sep 2023 21:32:59 +0200 Subject: [PATCH 4/5] =?UTF-8?q?=E2=9A=A1=EF=B8=8F=20upgraded=20typedoc=20t?= =?UTF-8?q?o=20version=200.25.1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package-lock.json | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index f0a758c..c247cfb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -48,7 +48,7 @@ "svelte-check": "^3.4.3", "tslib": "^2.4.1", "tsx": "^3.12.7", - "typedoc": "^0.24.8", + "typedoc": "^0.25.1", "typescript": "^5.0.0", "vite": "^4.4.2", "vitest": "^0.32.2" @@ -5743,24 +5743,24 @@ } }, "node_modules/typedoc": { - "version": "0.24.8", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.24.8.tgz", - "integrity": "sha512-ahJ6Cpcvxwaxfu4KtjA8qZNqS43wYt6JL27wYiIgl1vd38WW/KWX11YuAeZhuz9v+ttrutSsgK+XO1CjL1kA3w==", + "version": "0.25.1", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.1.tgz", + "integrity": "sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==", "dev": true, "dependencies": { "lunr": "^2.3.9", "marked": "^4.3.0", - "minimatch": "^9.0.0", + "minimatch": "^9.0.3", "shiki": "^0.14.1" }, "bin": { "typedoc": "bin/typedoc" }, "engines": { - "node": ">= 14.14" + "node": ">= 16" }, "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x" + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x" } }, "node_modules/typedoc/node_modules/brace-expansion": { diff --git a/package.json b/package.json index 91c6843..97642c4 100644 --- a/package.json +++ b/package.json @@ -50,7 +50,7 @@ "svelte-check": "^3.4.3", "tslib": "^2.4.1", "tsx": "^3.12.7", - "typedoc": "^0.24.8", + "typedoc": "^0.25.1", "typescript": "^5.0.0", "vite": "^4.4.2", "vitest": "^0.32.2" From e28ebda7a74116aeb3626f2b4031a3db6f6d2b80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hannes=20R=C3=BCger?= Date: Tue, 5 Sep 2023 13:31:28 +0200 Subject: [PATCH 5/5] fix: update `@mxssfd/typedoc-theme` to support `typedoc@0.25` --- package-lock.json | 10 +++++----- package.json | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index c247cfb..8db3ee4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -24,7 +24,7 @@ "typescript-json-schema": "^0.60.0" }, "devDependencies": { - "@mxssfd/typedoc-theme": "^1.1.2", + "@mxssfd/typedoc-theme": "^1.1.3", "@playwright/test": "^1.28.1", "@sveltejs/adapter-auto": "^2.0.0", "@sveltejs/adapter-node": "^1.3.1", @@ -403,15 +403,15 @@ "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==" }, "node_modules/@mxssfd/typedoc-theme": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@mxssfd/typedoc-theme/-/typedoc-theme-1.1.2.tgz", - "integrity": "sha512-Q/9Z+sff8ey92PaB7bnsGOfyNa85vTjyofO8EOH8KwEdfGnV4lGXwLFt4AUth7CCqYplqI9q4JxHNt869mlEcw==", + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@mxssfd/typedoc-theme/-/typedoc-theme-1.1.3.tgz", + "integrity": "sha512-/yP5rqhvibMpzXpmw0YLLRCpoj3uVWWlwyJseZXzGxTfiA6/fd1uubUqNoQAi2U19atMDonq8mQc+hlVctrX4g==", "dev": true, "engines": { "node": ">= 14" }, "peerDependencies": { - "typedoc": "^0.24.8" + "typedoc": "^0.25.1" } }, "node_modules/@nodelib/fs.scandir": { diff --git a/package.json b/package.json index 97642c4..6938c27 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,7 @@ "test:unit": "vitest" }, "devDependencies": { - "@mxssfd/typedoc-theme": "^1.1.2", + "@mxssfd/typedoc-theme": "^1.1.3", "@playwright/test": "^1.28.1", "@sveltejs/adapter-auto": "^2.0.0", "@sveltejs/adapter-node": "^1.3.1",