-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #36 from code0-tech/33-docs-preview
Add script for docs preview
- Loading branch information
Showing
2 changed files
with
15 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters