Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
add section about offline viewing
  • Loading branch information
cuppajoeman authored Nov 7, 2023
1 parent ce641c4 commit ea8dbe5
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------

Expand Down

0 comments on commit ea8dbe5

Please sign in to comment.