diff --git a/README.md b/README.md index 0a15fd7..46cf5e1 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,19 @@ The template allows you to start your own Jupyter Book and hosting that book onl 3. Set source for GitHub pages to under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`: + `Pages` - `Build and deployment` - `Source` - `GitHub Actions`. As long as you don't do this your book is not published online: ![Activate pages](figures/set_up_pages.png) -4. Set repository website as your GitHub Pages website under `Code`- `About` - - `Website` - `Use your GitHub Pages Website` - -![GitHub pages as website](figures/use_github_pages_website.png) - -4. Wait a few minutes for the website to be deployed, if you're curious, have a look at the progress under `Actions` - `All workflows` - `call-deploy-book` -`specific workflow run`: +5. Make a edit to the book by editing one of the files in the `book/` subdirectory (available under `Code`) or by running the workflow from `Actions` - `All workflows` - `call-deploy-book` - `Run workflow` - `Run workflow`. Wait a few minutes for the website to be deployed, if you're curious, you can see the progress and result under `Actions` - `All workflows` - `call-deploy-book` -`` (The first commit might have failed because github pages wasn't activated at the time of `Initial commit`): ![Action](figures/action.png) 5. When the workflow has finished, visit your build book at `https://.github.io/` (case sensitive). For our example it is [https://dummydocent.github.io/test_book_from_template/](https://dummydocent.github.io/test_book_from_template/) for the shown repository. These links are visible in the action as well, as shown in the figure above or in the GitHub repository website which you set in step 3. + +Additional tip: +Set the repository website as your GitHub Pages website under `Code`- `About` - - `Website` - `Use your GitHub Pages Website` + +![github_pages_as_website](figures/use_github_pages_website.png) \ No newline at end of file