Skip to content

Commit

Permalink
Merge pull request #36 from code0-tech/33-docs-preview
Browse files Browse the repository at this point in the history
Add script for docs preview
  • Loading branch information
Taucher2003 authored Dec 28, 2023
2 parents 85be985 + 139128c commit 0e766a6
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
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

0 comments on commit 0e766a6

Please sign in to comment.