From 00dcc96f5ef81d4e23362c025fa14f7db6e5dd92 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 18 Apr 2024 10:08:56 +0200 Subject: [PATCH] Stripped out myst formatting --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 722dd14..de7e15c 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,32 @@ # Your first TeachBook using the GitHub template -```{admonition} User types -:class: tip -This page is useful for user type 3, 4 and 5. -``` This page shows you how as an example how to start your own Jupyter Book and hosting that book online. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. 1. To get started making your Jupyter Book with our functionalities, use the [template book](https://github.com/TeachBooks/template) as template: -```{figure} figures/use_template.png -:name: use-template -``` +![use-template](figures/use_template.png) 2. Fill in a repository name, this name will be used in the future url of your book: -```{figure} figures/create_new_repository.png -:name: create_new_repository -``` +![create_new_repository](figures/create_new_repository.png) 3. Set source for GitHub pages to under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`: -```{figure} figures/set_up_pages.png -:name: activate_pages -``` +![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` -```{figure} figures/use_github_pages_website.png -:name: github_pages_as_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`: -```{figure} figures/action.png -:name: action -``` +![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.. Now that you have your book, you can continue editing your book as described in the other chapters in this book \ No newline at end of file