Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/content/docs/preview.md
Original file line number Diff line number Diff line change
@@ -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).
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down