From 605b2769cdb0302e1a043283ef998b5af94510ab Mon Sep 17 00:00:00 2001 From: Niklas van Schrick Date: Mon, 25 Dec 2023 13:52:55 +0100 Subject: [PATCH 1/2] Add script for docs preview --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 80d7e2f4..5aa33e06 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,8 @@ "storybook:build": "storybook build", "storybook:test": "test-storybook", "storybook:test:all": "test-storybook --browsers chromium firefox webkit", - "storybook:test:update": "npm run storybook:test:all -- -u" + "storybook:test:update": "npm run storybook:test:all -- -u", + "docs:preview": "npm run --prefix ../telescopium project:preview pictor" }, "author": "Code0", "license": "MIT", From 139128c33cd20cc1997a95de8db1334841f5a725 Mon Sep 17 00:00:00 2001 From: Niklas van Schrick Date: Wed, 27 Dec 2023 20:40:32 +0100 Subject: [PATCH 2/2] Add page for local docs preview --- docs/content/docs/preview.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/content/docs/preview.md diff --git a/docs/content/docs/preview.md b/docs/content/docs/preview.md new file mode 100644 index 00000000..270df744 --- /dev/null +++ b/docs/content/docs/preview.md @@ -0,0 +1,13 @@ +--- +title: Documentation Preview +--- + +The `docs:preview` task provides an opiniated solution for previewing the documentation for this project locally. + +It sets some expectations on the local project setup: + +- [`telescopium`](https://github.com/code0-tech/telescopium) is cloned in the same directory as `pictor`. +- The directory containing this project is named `pictor`. + +All requirements of the `telescopium` project itself apply as well. More information about them are +available in the [telescopium documentation](../../telescopium/preview.md).