From 9a8e2100e7e03b41db531010bca12b7c2b5364a6 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Thu, 14 Nov 2024 15:29:13 +0100 Subject: [PATCH 1/2] Example VS Code setup through build tasks This example allows any one to open the `docs` folder and build/serve the documentation without installing any dependencies. Just pressing CMD+SHIFT+B should suffice --- docs/.vscode/tasks.json | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/.vscode/tasks.json diff --git a/docs/.vscode/tasks.json b/docs/.vscode/tasks.json new file mode 100644 index 00000000..593d7af2 --- /dev/null +++ b/docs/.vscode/tasks.json @@ -0,0 +1,27 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "Build Documentation", + "type": "shell", + "command": "docker run -v .:/app/docs -v ./../.artifacts:/app/.artifacts ghcr.io/mpdreamz/docs-builder:edge", + "problemMatcher": [], + "group": { + "kind": "build", + "isDefault": true + } + }, + { + "label": "Serve Documentation", + "type": "shell", + "command": "docker run --expose 8080 -v .:/app/docs -v ./../.artifacts:/app/.artifacts ghcr.io/mpdreamz/docs-builder:edge serve", + "problemMatcher": [], + "group": { + "kind": "build", + "isDefault": true + } + } + ] +} \ No newline at end of file From cfb057c58150531d0aff7d16cf454ff1747c5fd7 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Thu, 14 Nov 2024 15:36:10 +0100 Subject: [PATCH 2/2] update to correct image --- docs/.vscode/tasks.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/.vscode/tasks.json b/docs/.vscode/tasks.json index 593d7af2..d73a3b5e 100644 --- a/docs/.vscode/tasks.json +++ b/docs/.vscode/tasks.json @@ -6,7 +6,7 @@ { "label": "Build Documentation", "type": "shell", - "command": "docker run -v .:/app/docs -v ./../.artifacts:/app/.artifacts ghcr.io/mpdreamz/docs-builder:edge", + "command": "docker run -v .:/app/docs -v ./../.artifacts:/app/.artifacts ghcr.io/mpdreamz/docset-builder:edge", "problemMatcher": [], "group": { "kind": "build", @@ -16,7 +16,7 @@ { "label": "Serve Documentation", "type": "shell", - "command": "docker run --expose 8080 -v .:/app/docs -v ./../.artifacts:/app/.artifacts ghcr.io/mpdreamz/docs-builder:edge serve", + "command": "docker run --expose 8080 -v .:/app/docs -v ./../.artifacts:/app/.artifacts ghcr.io/mpdreamz/docset-builder:edge serve", "problemMatcher": [], "group": { "kind": "build",