From 9cd2223b29826529e7d0278b93bb1b5812d3194e Mon Sep 17 00:00:00 2001 From: Max Wardle Date: Fri, 6 Dec 2024 10:33:48 -0800 Subject: [PATCH] updated local runtime instructions --- .gitignore | 8 +++++++- README.md | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 496ee2c..88e8669 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,7 @@ -.DS_Store \ No newline at end of file +.DS_Store + +# generated stuff from local run +patcher.py +test_patcher.py +site/ +tmp/ \ No newline at end of file diff --git a/README.md b/README.md index 565eb84..e02d0c4 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,4 @@ Start your new document from the new [Markdown document template](/new-markdown- # Deploy locally To deploy locally you need to have Node.js installed. If you don't have it installed, you can download it from [here](https://nodejs.org/en/download/). You will also need to have Docker installed. If you don't have it installed, you can download it from [here](https://www.docker.com/products/docker-desktop). -After you have Node.js and Docker installed, you can run the following commands to deploy the documentation locally: `npx @techdocs/cli serve`. A browser should open with an un-themed, but formatted version of the documentation. This closely resembles what will be visible on the end product. +After you have Node.js and Docker installed, you can follow these instructions to [preview content locally](https://github.com/bcgov/devhub-techdocs-publish/blob/main/docs/index.md#how-to-use-the-docker-image-to-preview-content-locally). A browser should open with an un-themed, but formatted version of the documentation. This closely resembles what will be visible on the end product.