Skip to content

Commit 1e31de8

Browse files
committed
Add instructions for config and toc
1 parent 6eb35b7 commit 1e31de8

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
# Training Template
22

3-
> Author Name
3+
> Krishna Kumar, UT Austin
44
5+
- Template for DesignSafe training built using [Jupyter Book](https://jupyterbook.org/en/stable/intro.html).
56
- Fork this [repo](https://github.com/DesignSafe-CI/training-template)
67
- To add `Open In DesignSafe` in Jupyter Notebooks copy the jupyter notebook to Community Data and then point the URL to the folder in Community Data `https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/`
78
- The repo will automatically build a website using GitHub pages
89

10+
## Template edits
11+
- `_config.yml` Edit for title, author and URL
12+
- `_toc.yml` Set-up the table of contents
13+
- You can write markdown and Jupyter Notebooks and add to table of contents `_toc.yml`
14+
15+
## Build locally
16+
17+
918
**Exercise:**
1019
[![Try on DesignSafe](https://raw.githubusercontent.com/DesignSafe-CI/training-template/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/CommunityData/Training/template/01-template-exercise.ipynb)
1120

_config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Book settings
22
# Learn more at https://jupyterbook.org/customize/config.html
33

4-
title: DesignSafe XAI training
5-
author: Krishna Kumar
4+
title: Training Template
5+
author: Author Name
66
logo: logo.png
77
copyright: "2024"
88

@@ -20,7 +20,7 @@ launch_buttons:
2020

2121
# Information about where the book exists on the web
2222
repository:
23-
url: https://github.com/DesignSafe-CI/2024-xai-course # Online location of your book
23+
url: https://github.com/DesignSafe-CI/training-template # Online location of your book
2424
path_to_book: docs # Optional path to your book, relative to the repository root
2525
branch: main # Which branch of the repository should be used when creating links (optional)
2626

@@ -30,4 +30,4 @@ html:
3030
use_issues_button: true
3131
use_repository_button: true
3232
extra_navbar: ""
33-
google_analytics_id: G-X06NJT7GSH
33+
google_analytics_id: G-XXXXXXXXXX

0 commit comments

Comments
 (0)