{"id":16220748,"url":"https://github.com/elc/jupyter-book-template","last_synced_at":"2025-04-03T03:30:36.409Z","repository":{"id":98145044,"uuid":"391223096","full_name":"ELC/jupyter-book-template","owner":"ELC","description":"Template Repo for building Jupyter Books","archived":true,"fork":false,"pushed_at":"2021-08-03T23:06:10.000Z","size":1612,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"source","last_synced_at":"2025-02-25T19:26:05.083Z","etag":null,"topics":["book","data-science","jupyter","jupyter-book","jupyter-notebooks","template"],"latest_commit_sha":null,"homepage":"https://elc.github.io/jupyter-book-template/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ELC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-31T01:03:09.000Z","updated_at":"2024-03-24T00:05:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"8777dd1d-dace-48ec-96d6-912340702ee6","html_url":"https://github.com/ELC/jupyter-book-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ELC%2Fjupyter-book-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ELC%2Fjupyter-book-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ELC%2Fjupyter-book-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ELC%2Fjupyter-book-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ELC","download_url":"https://codeload.github.com/ELC/jupyter-book-template/tar.gz/refs/heads/source","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933218,"owners_count":20857046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book","data-science","jupyter","jupyter-book","jupyter-notebooks","template"],"created_at":"2024-10-10T11:59:28.286Z","updated_at":"2025-04-03T03:30:36.363Z","avatar_url":"https://github.com/ELC.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jupyter Book Template\n\n[![Jupyter Book Badge](https://img.shields.io/badge/jupyter-book-orange?style=for-the-badge\u0026logo=data:image/png%3Bbase64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAZCAMAAAAVHr4VAAAAXVBMVEX////v7+/zdybv7+/zdybv7+/zdybv7+/zdybv7+/zdybv7+/zdybv7+/zdybv7+/zdybv7+/zdybv7+/v7+/zdybv7+/zdybv7+/v7+/zdybv7+/zdybv7+/zdyaSmqV2AAAAHXRSTlMAEBAgIDAwQEBQUGBgcHCAgJCQoLCwwMDQ4ODw8MDkUIUAAADJSURBVHjaddAFkgNBCAXQP+7uAvc/5tLFVseYF8crUB0560r/5gwvjYYm8gq8QJoyIJNwlnUH0WEnART6YSezV6c5tjOTaoKdfGXtnclFlEBEXVd8JzG4pa/LDql9Jff/ZCC/h2zSqF5bzf4vqkgNwEzeClUd8uMadLE6OnhBFsES5niQh2BOYUqZsfGdmrmbN+TMvPROHUOkde8sEs6Bnr0tDDf2Roj6fmVfubuGyttejCeLc+xFm+NLuLnJeFAyl3gS932MF/wBoukfUcwI05kAAAAASUVORK5CYII=)](https://elc.github.io/jupyter-book-template/)\n[![badge](https://img.shields.io/badge/launch-binder-579aca.svg?style=for-the-badge\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC)](https://mybinder.org/v2/gh/elc/jupyter-book-template/HEAD)\n[![badge](https://img.shields.io/badge/Open-In%20Colab-579aca?style=for-the-badge\u0026logo=googlecolab)](https://colab.research.google.com/github/ELC/jupyter-book-template/blob/source/chapters/00_how_to_use.ipynb)\n\nThis is **manual** Jupyter Book Template. The **manual** means there are some parameters you will have to modify by hand after using this repo as a template. For an **automatic** version, visit the [sibling repository](https://github.com/ELC/jupyter-book-template-cookiecutter) built on Cookiecutter. The features are identical, the setup steps might differ.\n\nCheck the final result [online](https://elc.github.io/jupyter-book-template/)\n\n## Getting Started\n\n### Step 1: Fork this Repository\n\nThis is a *template* repository, so you won't use it directly, you will use it a a template for new repositories. Github only allows to use templates you own so you will have to first fork it and follow these steps:\n\n- [ ] Fork the repository.\n- [ ] Make sure you have at least two branches: **source** and **master**\n- [ ] Enable **Template Repository** in Settings \u003e Options \u003e Template Repository.\n- [ ] Enable Github Actions if disable.\n- [ ] Enable GithubPages for the `master` branch in Settings \u003e Pages.\n- [ ] Clone the repo in your local PC.\n\n### Step 2: Use the Template\n\nNow, when creating a new repository, you should see the template in the dropdown and check \"Include all brnaches\".\n\n### Step 3: Customize\n\nClone the repo and open the folder with your favourite IDE / Editor and look for the term `REPLACE WITH` and replace the values with your custom information and remove the brackets. Examples for each are given below:\n\n- **Book Title** -\u003e Book Template\n- **Current Year** -\u003e 2021\n- **Project URL** -\u003e https://elc.github.com/jupyter-book-template\n- **Repository URL** -\u003e https://github.com/elc/jupyter-book-template\n- **Binder URL** -\u003e https://gke.mybinder.org/build/gh/elc/jupyter-book-template/source\n- **Google Analytics Tag** -\u003e UA-XXXXXXXX-X\n\nThen, some final TODOs:\n\n- [ ] Add the public link to the Github Page of the Repo.\n- [ ] Update Links to relevant Badges in this document.\n- [ ] Place all static assets (images, videos, etc.) inside the `_static` folder.\n- [ ] Check all available features in the Introduction chapter that comes with the book.\n- [ ] Delete this README and update it with project relevant information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felc%2Fjupyter-book-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felc%2Fjupyter-book-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felc%2Fjupyter-book-template/lists"}