From ea8dbe5b8532b3493aac065fed0b2b2389a1af59 Mon Sep 17 00:00:00 2001 From: ccn Date: Mon, 6 Nov 2023 19:51:26 -0500 Subject: [PATCH] Update readme.md add section about offline viewing --- readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/readme.md b/readme.md index 50724b08..5a3b06bb 100644 --- a/readme.md +++ b/readme.md @@ -36,6 +36,15 @@ using the local copies. It looks like this: If you are running Windows, there are a build.bat and a build_full.bat for convenience. When the script is done building, the completed site will be in a folder named `htdocs`. +Offline Viewing +--------------- +First compile the files using the `--local-assets` flag, while in the root project directory run +`python start_offline_webserver.py` which starts a local webserver on port 8000 which can be accessed +in your browser by going to the url `http://localhost:8000`. + +If you find that any functionality is missing, please open a pull request. + + File Structure --------------