-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
9 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,6 @@ | ||
# eefa-notebook | ||
Python scripts and Jupyter notebooks for the EEFA book | ||
|
||
Python scripts and Jupyter notebooks for the [EEFA book](https://www.eefabook.org) | ||
|
||
[![](https://media.springernature.com/full/springer-static/cover-hires/book/978-3-031-26588-4?as=webp) | ||
](https://link.springer.com/book/10.1007/978-3-031-26588-4) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,6 @@ | ||
## EEFA Notebook | ||
|
||
A template for turning Jupyter notebooks and markdown files into a website. | ||
Python scripts and Jupyter notebooks for the [EEFA book](https://www.eefabook.org) | ||
|
||
Steps to use this template: | ||
|
||
- Click the **Use this template** green button on this GitHub repo and fill in the details to create a repo under your account. | ||
- Clone the newly created repo to your computer and open it using a Text Editor (e.g., Visual Studio Code). | ||
- Use the Text Editor to search `mkdocs-template` and replace it with your repo name. | ||
- Add/remove dependencies in `requirements.txt` if need. | ||
- Add folders (e.g., `chapter_01`) and files (e.g., `intro.ipynb`, `index.md`) to the `docs` folder. | ||
- Open `mkdocs.yml` and make several changes, including `site_name`, `site_url`, `repo_url`, and `nav`. If you don't want the notebooks to be executed when building the website, set `execute: False` under `plugins`. | ||
- Customize the issue template (`.github/ISSUE_TEMPLATE/config.yml`) if needed. | ||
- Commit the changes using Git and push changes to GitHub. | ||
- Enable GitHub Pages through GitHub Settings - Pages. | ||
- Check out the website at https://username.github.io/repo-name. | ||
[![](https://media.springernature.com/full/springer-static/cover-hires/book/978-3-031-26588-4?as=webp) | ||
](https://link.springer.com/book/10.1007/978-3-031-26588-4) |