update docs and clean up

Signed-off-by: Morgan Bentell <mbentell@spotify.com>
This commit is contained in:
Morgan Bentell
2023-01-09 10:03:39 +01:00
parent 38cdc28135
commit 29113e760a
4 changed files with 4 additions and 2 deletions
+1 -1
View File
@@ -2,4 +2,4 @@
'@techdocs/cli': minor
---
Add `--preview-app-bundle-path` option to the `serve` command enabling previewing with apps other than the provided one
Add `--preview-app-bundle-path` and `--preview-app-port` options to the `serve` command enabling previewing with apps other than the provided one
+2
View File
@@ -95,6 +95,8 @@ Options:
--no-docker Do not use Docker, use MkDocs executable in current user environment.
--mkdocs-port <PORT> Port for MkDocs server to use (default: "8000")
--preview-app-bundle-path <PATH_TO_BUNDLE> Preview documentation using a web app other than the included one.
--preview-app-port <PORT> Port where the preview will be served.
Can only be used with "--preview-app-bundle-path". (default: "3000")
-v --verbose Enable verbose output. (default: false)
-h, --help display help for command
```
+1
View File
@@ -100,6 +100,7 @@ Options:
--no-docker
--mkdocs-port <PORT>
--preview-app-bundle-path <PATH_TO_BUNDLE>
--preview-app-port <PORT>
-v --verbose
-h, --help
```
@@ -117,7 +117,6 @@ export default async function serve(opts: OptionValues) {
const port = isDevMode ? backstageBackendPort : opts.previewAppPort;
const previewAppPath = getPreviewAppPath(opts);
console.log({ previewAppPath });
const httpServer = new HTTPServer(
previewAppPath,
port,