Skip to content

Commit

Permalink
updated README build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
murraybj committed Oct 15, 2024
1 parent da9a5bd commit c0af494
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,18 @@ then
`jupyter-book build ./`
to build the current working directory into a jupyter-book.

The html is in the folder `_build\html\` and you can preview the book by opening the file `_build\html\index.html`
The html is in the folder `_build\html\` and you can preview the book by opening the file `_build\html\index.html` in your browser, using VSCode's preview functionality (recommended), or running a the file via a browser executable in command line.

Following this, to deploy your build to the github page, we will be using the `ghp-import` library.

Install using `pip install ghp-import`

Now run `ghp-import -n -p -f -b BRANCHNAME _build/html`

**NOTE: This is a destructive action. It will overwrite any branch named BRANCHNAME and assume it is 100% derivative**

The -b tag should be followed by the branch which you wish to deploy the html to. By default it is gh-pages. If you're wishing to non-destructively test a local build, push to a separate branch name, and change the branch referenced for the github page in the settings, allowing for a quick revert to the gh-pages branch.

The -n tag indicates building without Jekyll

The -p and -f tags indicate force pushing this branch after committing it.

0 comments on commit c0af494

Please sign in to comment.