{"version":3,"kind":"Article","sha256":"ea989bc9b13799784c0b9f3b633c8e8b09114c97e0a8d3f7cae270d34c7a6a84","slug":"setup","location":"/content/lessons/0_setup.md","dependencies":[],"frontmatter":{"title":"Set up a new repository","numbering":{"title":{"offset":0,"enabled":true}},"content_includes_title":false,"authors":[{"nameParsed":{"literal":"Freek Pols","given":"Freek","family":"Pols"},"name":"Freek Pols","id":"contributors-myst-generated-uid-0"},{"nameParsed":{"literal":"Luuk Fröling","given":"Luuk","family":"Fröling"},"name":"Luuk Fröling","id":"contributors-myst-generated-uid-1"},{"nameParsed":{"literal":"Robert Lanzafame","given":"Robert","family":"Lanzafame"},"name":"Robert Lanzafame","id":"contributors-myst-generated-uid-2"},{"nameParsed":{"literal":"Kirstie Whitaker","given":"Kirstie","family":"Whitaker"},"name":"Kirstie Whitaker","id":"contributors-myst-generated-uid-3"},{"nameParsed":{"literal":"Jim Madge","given":"Jim","family":"Madge"},"name":"Jim Madge","id":"contributors-myst-generated-uid-4"}],"date":"2025-11-02","license":{"content":{"id":"CC-BY-4.0","url":"https://creativecommons.org/licenses/by/4.0/","name":"Creative Commons Attribution 4.0 International","free":true,"CC":true}},"github":"https://github.com/jupyter-book/workshop-template","edit_url":null,"abbreviations":{"JB2":"Jupyter Book 2","CI/CD":"Continuous Integration/Continuous Deployment","GHA":"GitHub Actions","GH":"GitHub","IDE":"Integrated Development Environment","VSC":"Visual Studio Code","CLI":"commmand line interface"},"source_url":"https://github.com/jupyter-book/workshop-template/blob/main/content/lessons/0_setup.md","enumerator":"1","thumbnail":"/build/startscreen-d442a73e81c4f5126b2cb72504fdfaf1.png","exports":[{"format":"md","filename":"0_setup.md","url":"/build/0_setup-4028e3e86d7f5a15219a4ea2d719eba8.md"}]},"mdast":{"type":"root","children":[{"type":"div","class":"font-light text-sm mb-4 updated-date-container","children":[{"type":"text","value":"Updated: 03 Nov 2025","key":"Y3yYAx7Qy0"}],"key":"CHnKAjFkjr"},{"type":"block","children":[{"type":"paragraph","position":{"start":{"line":9,"column":1},"end":{"line":9,"column":1}},"children":[{"type":"text","value":"The instructions on this page guide you through the process of:","position":{"start":{"line":9,"column":1},"end":{"line":9,"column":1}},"key":"PNJUxxuLEP"}],"key":"cKoP974zeg"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":11,"column":1},"end":{"line":14,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":11,"column":1},"end":{"line":11,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"making your own book by creating a (new) GitHub repository from a template repository,","position":{"start":{"line":11,"column":1},"end":{"line":11,"column":1}},"key":"sbPX3DxqkY"}],"key":"BbLxfPrExt"}],"key":"zsVQ3UJiDY"},{"type":"listItem","spread":true,"position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"making an edit to your book,","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"key":"getcsVt7AR"}],"key":"MU49IsnFXL"}],"key":"QBSGPK5Yx0"},{"type":"listItem","spread":true,"position":{"start":{"line":13,"column":1},"end":{"line":14,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"“building” your book and viewing it in a web browser via a local server and/or online with GitHub pages.","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"XXbcgcOARa"}],"key":"gPhVSVsCsR"}],"key":"FLR4g6XZVX"}],"key":"y2cgZmWwZK"},{"type":"admonition","kind":"tip","children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Tip","key":"M38oaUBVXu"}],"key":"bCYvETkQG9"},{"type":"paragraph","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"children":[{"type":"text","value":"We recommend you complete the lessons in this workshop by installing Jupyter Book on your computer and building the book using a command line interface (","key":"sC1FtK9haG"},{"type":"abbreviation","title":"commmand line interface","children":[{"type":"text","value":"CLI","key":"oErRarlTAn"}],"key":"Bj6hBmLreV"},{"type":"text","value":"). This is referred to as the ","key":"vZgLEWD6ie"},{"type":"strong","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"children":[{"type":"text","value":"local","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"key":"Xnh9FTmcHj"}],"key":"UBiewy6b1i"},{"type":"text","value":" approach. If you are unable to use the ","key":"KHNBYyJjnw"},{"type":"abbreviation","title":"commmand line interface","children":[{"type":"text","value":"CLI","key":"JczQSXtmZ4"}],"key":"ci0QqdJSTb"},{"type":"text","value":", or do not wish to, tt is possible to complete this workshop by working entirely in the browser. This is referred to as the ","key":"P5h8GijhMa"},{"type":"strong","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"children":[{"type":"text","value":"online","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"key":"WQVnOcXtF7"}],"key":"WLYf2hUD4z"},{"type":"text","value":" approach. When instructions are different for each approach, tab sets will be used, as illustrated here:","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"key":"bWT10frxIF"}],"key":"Mvu5c025Gp"},{"type":"tabSet","children":[{"type":"tabItem","title":"Locally","children":[{"type":"paragraph","position":{"start":{"line":20,"column":1},"end":{"line":20,"column":1}},"children":[{"type":"text","value":"Instructions specific for those working using a ","key":"AJfpWjNVf2"},{"type":"abbreviation","title":"commmand line interface","children":[{"type":"text","value":"CLI","key":"c2bbedje6L"}],"key":"hOWdW1gWOr"},{"type":"text","value":" and Jupyter Book installed “locally.”","key":"MVnrjfPuef"}],"key":"nQPiDmV5WO"}],"key":"astf5AZMcJ"},{"type":"tabItem","title":"Online","children":[{"type":"paragraph","position":{"start":{"line":23,"column":1},"end":{"line":23,"column":1}},"children":[{"type":"text","value":"Instructions specific for those working online using tools available via ","position":{"start":{"line":23,"column":1},"end":{"line":23,"column":1}},"key":"HYOYiO55Ue"},{"type":"inlineCode","value":"github.com","position":{"start":{"line":23,"column":1},"end":{"line":23,"column":1}},"key":"mWRxSB6kCP"},{"type":"text","value":" (e.g., the ","position":{"start":{"line":23,"column":1},"end":{"line":23,"column":1}},"key":"v4Wr8k2pOG"},{"type":"inlineCode","value":"github.dev","position":{"start":{"line":23,"column":1},"end":{"line":23,"column":1}},"key":"YwzJp4Ln46"},{"type":"text","value":" ","key":"TOAQtiFmuu"},{"type":"abbreviation","title":"Integrated Development Environment","children":[{"type":"text","value":"IDE","key":"G3UD86R5SM"}],"key":"mDLPsh3OOw"},{"type":"text","value":") and GitHub Actions workflows.","key":"rwWsK9giMq"}],"key":"dOZHfxIqn1"}],"key":"UKItTorLqT"}],"key":"PXMXHjmGht"}],"key":"BLb9qNdSmN"},{"type":"heading","depth":2,"position":{"start":{"line":29,"column":1},"end":{"line":29,"column":1}},"children":[{"type":"text","value":"Create a repository","position":{"start":{"line":29,"column":1},"end":{"line":29,"column":1}},"key":"y3t1F1fwBh"}],"identifier":"create-a-repository","label":"Create a repository","html_id":"create-a-repository","implicit":true,"key":"bR3tubLtyw"},{"type":"paragraph","position":{"start":{"line":31,"column":1},"end":{"line":31,"column":1}},"children":[{"type":"text","value":"Follow these instruction to use the GitHub template repository to create your own book for this workshop:","position":{"start":{"line":31,"column":1},"end":{"line":31,"column":1}},"key":"G75zs3xa7U"}],"key":"DO2X3wqo97"},{"type":"list","ordered":true,"start":1,"spread":false,"position":{"start":{"line":33,"column":1},"end":{"line":37,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":33,"column":1},"end":{"line":33,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Go to the ","position":{"start":{"line":33,"column":1},"end":{"line":33,"column":1}},"key":"vEaQWpOe7V"},{"type":"link","url":"https://github.com/jupyter-book/workshop-template/","position":{"start":{"line":33,"column":1},"end":{"line":33,"column":1}},"children":[{"type":"text","value":"repository for this book","position":{"start":{"line":33,"column":1},"end":{"line":33,"column":1}},"key":"gNklLp5TRJ"}],"urlSource":"https://github.com/jupyter-book/workshop-template/","error":true,"key":"AuqeSGoM8w"}],"key":"XKRqJhovr8"}],"key":"zEtfP6JUQ4"},{"type":"listItem","spread":true,"position":{"start":{"line":34,"column":1},"end":{"line":34,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Click the green button ","position":{"start":{"line":34,"column":1},"end":{"line":34,"column":1}},"key":"YxZHREMLl5"},{"type":"inlineCode","value":"use this template","position":{"start":{"line":34,"column":1},"end":{"line":34,"column":1}},"key":"phzcLsShtV"},{"type":"text","value":" and click ","position":{"start":{"line":34,"column":1},"end":{"line":34,"column":1}},"key":"Mr6SVjYkHX"},{"type":"inlineCode","value":"create a new repository","position":{"start":{"line":34,"column":1},"end":{"line":34,"column":1}},"key":"wBs9MjjmTz"},{"type":"text","value":".","position":{"start":{"line":34,"column":1},"end":{"line":34,"column":1}},"key":"fBTcNc3pxM"}],"key":"mbK358XGCA"}],"key":"bFLecc0drP"},{"type":"listItem","spread":true,"position":{"start":{"line":35,"column":1},"end":{"line":35,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Choose a proper name of your repository (this will be also part of your URL!) and choose the option ","position":{"start":{"line":35,"column":1},"end":{"line":35,"column":1}},"key":"HYsjmaP3jr"},{"type":"inlineCode","value":"public","position":{"start":{"line":35,"column":1},"end":{"line":35,"column":1}},"key":"zv3NJxqSi3"},{"type":"text","value":".","position":{"start":{"line":35,"column":1},"end":{"line":35,"column":1}},"key":"jprKlsdi3P"}],"key":"pfeS8ztEs5"}],"key":"nZnvkoIr7a"},{"type":"listItem","spread":true,"position":{"start":{"line":36,"column":1},"end":{"line":37,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"In your repository, click on ","position":{"start":{"line":36,"column":1},"end":{"line":36,"column":1}},"key":"IpG8gL1UkU"},{"type":"inlineCode","value":"settings","position":{"start":{"line":36,"column":1},"end":{"line":36,"column":1}},"key":"so1zMaw8tc"},{"type":"text","value":" and in the left menu on Pages and choose ","position":{"start":{"line":36,"column":1},"end":{"line":36,"column":1}},"key":"H8fDfJ4rju"},{"type":"inlineCode","value":"Github Actions","position":{"start":{"line":36,"column":1},"end":{"line":36,"column":1}},"key":"LdW0k2rEey"}],"key":"DfDxh2jj8A"}],"key":"MI4BQ8FRsB"}],"key":"yYRbeaEKzR"},{"type":"admonition","kind":"tip","children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Tip","key":"pWsYy2xQPc"}],"key":"XlUEGVzblC"},{"type":"paragraph","position":{"start":{"line":39,"column":1},"end":{"line":39,"column":1}},"children":[{"type":"text","value":"GitHub Actions will be covered later in this workshop, so if you have no idea what this is, don’t worry!","position":{"start":{"line":39,"column":1},"end":{"line":39,"column":1}},"key":"Ne9qgWHj1v"}],"key":"GX864hoIcm"}],"key":"o9wIetCmDM"},{"type":"container","kind":"figure","children":[{"type":"iframe","src":"https://www.youtube.com/embed/UZpo_S8QNZI?si=dz-xbWzOyUUlIwJ5","key":"CvmwC0Crsz"},{"type":"caption","children":[{"type":"paragraph","position":{"start":{"line":45,"column":1},"end":{"line":45,"column":1}},"children":[{"type":"captionNumber","kind":"figure","label":"vid_1","identifier":"vid_1","html_id":"vid-1","enumerator":"1","children":[{"type":"text","value":"Figure ","key":"HVW9GuIVcW"},{"type":"text","value":"1","key":"RdhVY7bLc9"},{"type":"text","value":":","key":"nXVOwprdd8"}],"template":"Figure %s:","key":"pEpQlI87gq"},{"type":"text","value":"Follow these steps to create your own repository from the template.","position":{"start":{"line":45,"column":1},"end":{"line":45,"column":1}},"key":"FKsPqgGOpq"}],"key":"Amc69hx82Z"}],"key":"xGXO039jyU"}],"label":"vid_1","identifier":"vid_1","enumerator":"1","html_id":"vid-1","key":"gk64sH7J9V"},{"type":"list","ordered":true,"start":5,"spread":false,"position":{"start":{"line":48,"column":1},"end":{"line":51,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Click on ","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"Ul8SdDNuqW"},{"type":"inlineCode","value":"code","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"xmHG28spkF"},{"type":"text","value":" and click on the ","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"binguMSJQI"},{"type":"inlineCode","value":"gear-icon","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"Az5Si8rAVY"},{"type":"text","value":" (near ","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"HgYapvZauv"},{"type":"strong","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"children":[{"type":"text","value":"About","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"eLILc5OyxO"}],"key":"k8aGy4zEM1"},{"type":"text","value":") at the right site of the page.","position":{"start":{"line":48,"column":1},"end":{"line":48,"column":1}},"key":"crv6gzoIgv"}],"key":"mg0rHZvVHF"}],"key":"KykxNPRJki"},{"type":"listItem","spread":true,"position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Check the box ","position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}},"key":"v3X0o145xb"},{"type":"strong","position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}},"children":[{"type":"text","value":"Use your GitHub Pages website","position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}},"key":"Tz60w79DLk"}],"key":"zVeiGv1D2T"},{"type":"text","value":".","position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}},"key":"nFk6Nx4AV1"}],"key":"HFKxH49O9w"}],"key":"j7jJZg4CHN"},{"type":"listItem","spread":true,"position":{"start":{"line":50,"column":1},"end":{"line":51,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Go to ","position":{"start":{"line":50,"column":1},"end":{"line":50,"column":1}},"key":"gpyRjvIext"},{"type":"inlineCode","value":"Actions","position":{"start":{"line":50,"column":1},"end":{"line":50,"column":1}},"key":"z21gZXHhcv"},{"type":"text","value":" in the top menu, click on the (red) ","position":{"start":{"line":50,"column":1},"end":{"line":50,"column":1}},"key":"VwCjeWiezE"},{"type":"inlineCode","value":"initial commit","position":{"start":{"line":50,"column":1},"end":{"line":50,"column":1}},"key":"ppfaW1JWeD"},{"type":"text","value":" and click ","position":{"start":{"line":50,"column":1},"end":{"line":50,"column":1}},"key":"s1vhyP2wA7"},{"type":"inlineCode","value":"re-run all jobs","position":{"start":{"line":50,"column":1},"end":{"line":50,"column":1}},"key":"oXPlcVsGbr"}],"key":"Ip9dHKIZic"}],"key":"ST7Wh3zHh4"}],"key":"ctutFsWShy"},{"type":"paragraph","position":{"start":{"line":52,"column":1},"end":{"line":52,"column":1}},"children":[{"type":"text","value":"The book will now be deployed again - where now it can actually load GitHub pages.","position":{"start":{"line":52,"column":1},"end":{"line":52,"column":1}},"key":"LYb1fIf4Lf"}],"key":"GNHtrE1nTm"},{"type":"container","kind":"figure","children":[{"type":"iframe","src":"https://www.youtube.com/embed/gQP_gjrh7rQ?si=DWiL_J27_a35RV__","key":"fDWlEyWJmD"},{"type":"caption","children":[{"type":"paragraph","position":{"start":{"line":57,"column":1},"end":{"line":57,"column":1}},"children":[{"type":"captionNumber","kind":"figure","label":"vid_2","identifier":"vid_2","html_id":"vid-2","enumerator":"2","children":[{"type":"text","value":"Figure ","key":"VYvoZ8yRbu"},{"type":"text","value":"2","key":"WMQFYJA6AQ"},{"type":"text","value":":","key":"GJYwjAZFUr"}],"template":"Figure %s:","key":"Bm1t7tWt1F"},{"type":"text","value":"Follow these steps to create your own ","key":"RIyvuiilCw"},{"type":"abbreviation","title":"GitHub","children":[{"type":"text","value":"GH","key":"Xzbehr8qiJ"}],"key":"CLIUPH23Zs"},{"type":"text","value":" Pages site from the template.","key":"ONa7clicjm"}],"key":"XIIPH9M9bA"}],"key":"FnXs4U2eBw"}],"label":"vid_2","identifier":"vid_2","enumerator":"2","html_id":"vid-2","key":"db18rqzXqM"},{"type":"heading","depth":2,"position":{"start":{"line":60,"column":1},"end":{"line":60,"column":1}},"children":[{"type":"text","value":"View your book online","position":{"start":{"line":60,"column":1},"end":{"line":60,"column":1}},"key":"Ip7LdWEPPE"}],"identifier":"view-your-book-online","label":"View your book online","html_id":"view-your-book-online","implicit":true,"key":"EOQxKmbmzk"},{"type":"paragraph","position":{"start":{"line":62,"column":1},"end":{"line":62,"column":1}},"children":[{"type":"text","value":"The previous stps set up your repository with GitHub Pages, which a GitHub Actions workflow to automatically build your book (a website) and deploy it online. The URL of your book is based on your GitHub username:","position":{"start":{"line":62,"column":1},"end":{"line":62,"column":1}},"key":"cLsRQw7dBO"}],"key":"JPJnZHmZVl"},{"type":"code","lang":"","value":"https://USERNAME.github.io/workshop-template","position":{"start":{"line":64,"column":1},"end":{"line":66,"column":1}},"key":"mlisGaooGE"},{"type":"paragraph","position":{"start":{"line":68,"column":1},"end":{"line":69,"column":1}},"children":[{"type":"text","value":"This is, in fact, how the website for this document is created:","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"key":"muBCqmPhQU"},{"type":"break","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"key":"w1na1smrE5"},{"type":"link","url":"https://jupyter-book.github.io/workshop-template/","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"children":[{"type":"text","value":"https://​jupyter​-book​.github​.io​/workshop​-template/","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"key":"C5N85oDwR2"}],"urlSource":"https://jupyter-book.github.io/workshop-template/","key":"U4HbLfwJgQ"}],"key":"WFf3h9usSb"},{"type":"paragraph","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"children":[{"type":"text","value":"You can also find the link easily from you GitHub repository home page under the “About” section on the right-hand side (illustrated in ","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"key":"GLQKs158ke"},{"type":"crossReference","kind":"figure","identifier":"fig_folderstructure","label":"fig_folderstructure","children":[{"type":"text","value":"Figure ","key":"p9FnfgZCui"},{"type":"text","value":"4","key":"MTY3bT8LRy"}],"template":"Figure %s","enumerator":"4","resolved":true,"html_id":"fig-folderstructure","key":"Zs9tYGZew3"},{"type":"text","value":").","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"key":"xvjrL75O6p"}],"key":"usTPQzIna6"},{"type":"paragraph","position":{"start":{"line":73,"column":1},"end":{"line":73,"column":1}},"children":[{"type":"text","value":"The home page of your new book website should look like ","position":{"start":{"line":73,"column":1},"end":{"line":73,"column":1}},"key":"kEzfoOrIRd"},{"type":"crossReference","kind":"figure","identifier":"fig_startscreen","label":"fig_startscreen","children":[{"type":"text","value":"Figure ","key":"VGIMIFpTyg"},{"type":"text","value":"3","key":"Ietd6RE2SI"}],"template":"Figure %s","enumerator":"3","resolved":true,"html_id":"fig-startscreen","key":"WxY3YRWBez"},{"type":"text","value":".","position":{"start":{"line":73,"column":1},"end":{"line":73,"column":1}},"key":"ofeQznsn3J"}],"key":"tKfuP63hoM"},{"type":"container","kind":"figure","children":[{"type":"image","url":"/build/startscreen-d442a73e81c4f5126b2cb72504fdfaf1.png","alt":"The home page of your new site, which you can visit once the GitHub Action workflow has successfully completed.","width":"100%","data":{"altTextIsAutoGenerated":true},"key":"YVc6WKJ10i","urlSource":"figures/startscreen.png"},{"type":"caption","children":[{"type":"paragraph","position":{"start":{"line":79,"column":1},"end":{"line":79,"column":1}},"children":[{"type":"captionNumber","kind":"figure","label":"fig_startscreen","identifier":"fig_startscreen","html_id":"fig-startscreen","enumerator":"3","children":[{"type":"text","value":"Figure ","key":"sY7V3Wqz5o"},{"type":"text","value":"3","key":"W7wCsh8xam"},{"type":"text","value":":","key":"vcKlKkPxpx"}],"template":"Figure %s:","key":"SL2EVbEbNQ"},{"type":"text","value":"The home page of your new site, which you can visit once the GitHub Action workflow has successfully completed.","position":{"start":{"line":79,"column":1},"end":{"line":79,"column":1}},"key":"Rdl0VfbGlI"}],"key":"fgegLszMq4"}],"key":"XRV37ZQ1fN"}],"label":"fig_startscreen","identifier":"fig_startscreen","enumerator":"3","html_id":"fig-startscreen","key":"SibRovzokt"},{"type":"admonition","kind":"tip","children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Tip","key":"ijxg54j7uk"}],"key":"e8gbzPblar"},{"type":"paragraph","position":{"start":{"line":83,"column":1},"end":{"line":83,"column":1}},"children":[{"type":"text","value":"Checkout the content on your mobile phone as well! It just looks amazing.","position":{"start":{"line":83,"column":1},"end":{"line":83,"column":1}},"key":"riPP4ZCSpb"}],"key":"VCjMwM0aos"}],"key":"OZgTXkmE3E"},{"type":"heading","depth":2,"position":{"start":{"line":86,"column":1},"end":{"line":86,"column":1}},"children":[{"type":"text","value":"Repo folder structure","position":{"start":{"line":86,"column":1},"end":{"line":86,"column":1}},"key":"juCcIoxmb1"}],"identifier":"repo-folder-structure","label":"Repo folder structure","html_id":"repo-folder-structure","implicit":true,"key":"huMlt6LYob"},{"type":"paragraph","position":{"start":{"line":88,"column":1},"end":{"line":88,"column":1}},"children":[{"type":"text","value":"Your GitHub repository may look similar to the one shown in ","position":{"start":{"line":88,"column":1},"end":{"line":88,"column":1}},"key":"hoHdBpkeJB"},{"type":"crossReference","kind":"figure","identifier":"fig_folderstructure","label":"fig_folderstructure","children":[{"type":"text","value":"Figure ","key":"LBLOrRSHhr"},{"type":"text","value":"4","key":"pmbUoTIxhp"}],"template":"Figure %s","enumerator":"4","resolved":true,"html_id":"fig-folderstructure","key":"zBnzuEMtFA"},{"type":"text","value":"; note the following directories:","position":{"start":{"line":88,"column":1},"end":{"line":88,"column":1}},"key":"Ej2o3PBCHP"}],"key":"iL1yx6ND3R"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":90,"column":1},"end":{"line":96,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":90,"column":1},"end":{"line":90,"column":1}},"children":[{"type":"paragraph","children":[{"type":"inlineCode","value":"content","position":{"start":{"line":90,"column":1},"end":{"line":90,"column":1}},"key":"FyBW6DnbhY"},{"type":"text","value":": the source files of your book (in markdown or jupyter notebook format),","position":{"start":{"line":90,"column":1},"end":{"line":90,"column":1}},"key":"gEvQHEZAR9"}],"key":"kuPKBdFDKf"}],"key":"kpKC0OyEal"},{"type":"listItem","spread":true,"position":{"start":{"line":91,"column":1},"end":{"line":91,"column":1}},"children":[{"type":"paragraph","children":[{"type":"inlineCode","value":"content/figures","position":{"start":{"line":91,"column":1},"end":{"line":91,"column":1}},"key":"Ij5O6OY1O1"},{"type":"text","value":": the folder which includes figures for your book,","position":{"start":{"line":91,"column":1},"end":{"line":91,"column":1}},"key":"kria2MqtqE"}],"key":"nasDbJnNNN"}],"key":"b7A7VSYlOv"},{"type":"listItem","spread":true,"position":{"start":{"line":92,"column":1},"end":{"line":92,"column":1}},"children":[{"type":"paragraph","children":[{"type":"inlineCode","value":"content/lessons","position":{"start":{"line":92,"column":1},"end":{"line":92,"column":1}},"key":"XI27rszjCQ"},{"type":"text","value":": the folder which includes the lessons of this workshop,","position":{"start":{"line":92,"column":1},"end":{"line":92,"column":1}},"key":"qZrOUhFq5u"}],"key":"xzBpZpfryf"}],"key":"j5sac0tP5e"},{"type":"listItem","spread":true,"position":{"start":{"line":93,"column":1},"end":{"line":93,"column":1}},"children":[{"type":"paragraph","children":[{"type":"inlineCode","value":".github/workflows","position":{"start":{"line":93,"column":1},"end":{"line":93,"column":1}},"key":"eSoSOE3HKq"},{"type":"text","value":": the folder which includes the GitHub Actions (automated workflows) to build and deploy your book,","position":{"start":{"line":93,"column":1},"end":{"line":93,"column":1}},"key":"XByzlmqciL"}],"key":"dfOQrS5YSK"}],"key":"kCypNarslU"},{"type":"listItem","spread":true,"position":{"start":{"line":94,"column":1},"end":{"line":94,"column":1}},"children":[{"type":"paragraph","children":[{"type":"inlineCode","value":"css","position":{"start":{"line":94,"column":1},"end":{"line":94,"column":1}},"key":"LXC3RadDsn"},{"type":"text","value":": a folder which includes a custom css file to change the layout of your book,","position":{"start":{"line":94,"column":1},"end":{"line":94,"column":1}},"key":"caNCBmLNyC"}],"key":"qcHVZfsCk5"}],"key":"dt4MdmG9j6"},{"type":"listItem","spread":true,"position":{"start":{"line":95,"column":1},"end":{"line":96,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"A ","position":{"start":{"line":95,"column":1},"end":{"line":95,"column":1}},"key":"pqn2n19PQy"},{"type":"inlineCode","value":"myst.yml","position":{"start":{"line":95,"column":1},"end":{"line":95,"column":1}},"key":"oXNAQKRaoA"},{"type":"text","value":" file which defines the structure and settings of your Jupyter Book.","position":{"start":{"line":95,"column":1},"end":{"line":95,"column":1}},"key":"KPQctWAf6I"}],"key":"sQ1VeyaHVC"}],"key":"HH7l2LeGrM"}],"key":"S8XocKCzkr"},{"type":"container","kind":"figure","children":[{"type":"image","url":"/build/Folderstructure-a39806cdb7c3caa541b70536800dbba5.png","alt":"Illustration of repository folder structure.","width":"100%","data":{"altTextIsAutoGenerated":true},"key":"qSrF1k4v8z","urlSource":"figures/Folderstructure.png"},{"type":"caption","children":[{"type":"paragraph","position":{"start":{"line":101,"column":1},"end":{"line":101,"column":1}},"children":[{"type":"captionNumber","kind":"figure","label":"fig_folderstructure","identifier":"fig_folderstructure","html_id":"fig-folderstructure","enumerator":"4","children":[{"type":"text","value":"Figure ","key":"DMh6LcCbb5"},{"type":"text","value":"4","key":"IYqSvQs0QS"},{"type":"text","value":":","key":"Wc1l019WE5"}],"template":"Figure %s:","key":"cEHiRPMdbt"},{"type":"text","value":"Illustration of repository folder structure.","position":{"start":{"line":101,"column":1},"end":{"line":101,"column":1}},"key":"ypAKYXwxLN"}],"key":"dUx1F65zRg"}],"key":"LtkXZODWV2"}],"label":"fig_folderstructure","identifier":"fig_folderstructure","enumerator":"4","html_id":"fig-folderstructure","key":"SBewHLuJVR"},{"type":"paragraph","position":{"start":{"line":104,"column":1},"end":{"line":104,"column":1}},"children":[{"type":"text","value":"As proceed through the workshop you will edit the files in your new repository.","position":{"start":{"line":104,"column":1},"end":{"line":104,"column":1}},"key":"xJfSwh7fjO"}],"key":"sUcYFq9FUV"},{"type":"heading","depth":2,"position":{"start":{"line":106,"column":1},"end":{"line":106,"column":1}},"children":[{"type":"text","value":"Edit the book","position":{"start":{"line":106,"column":1},"end":{"line":106,"column":1}},"key":"YRNqaEUF1o"}],"identifier":"edit-the-book","label":"Edit the book","html_id":"edit-the-book","implicit":true,"key":"OxAShR7k23"},{"type":"paragraph","position":{"start":{"line":108,"column":1},"end":{"line":108,"column":1}},"children":[{"type":"text","value":"You have a number of options for making changes to the book’s source and seeing how they affect the output.","position":{"start":{"line":108,"column":1},"end":{"line":108,"column":1}},"key":"q9zLnB7OKj"}],"key":"R9JX3D9PJR"},{"type":"tabSet","children":[{"type":"tabItem","title":"Locally","children":[{"type":"list","ordered":true,"start":1,"spread":false,"position":{"start":{"line":113,"column":1},"end":{"line":114,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":113,"column":1},"end":{"line":114,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Clone the repository to your local machine using Git.","position":{"start":{"line":113,"column":1},"end":{"line":113,"column":1}},"key":"sqTJDZtILt"}],"key":"shE9zEBHG9"}],"key":"kwfZTlfq81"}],"key":"LbNhTH3K8e"},{"type":"code","lang":"console","value":"git clone git@github.com:<github_user_name>/workshop-template.git","position":{"start":{"line":115,"column":1},"end":{"line":117,"column":1}},"key":"OPeP0wZ3UU"},{"type":"list","ordered":true,"start":2,"spread":false,"position":{"start":{"line":119,"column":1},"end":{"line":120,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":119,"column":1},"end":{"line":120,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Install Jupyter Book, using the virtual environment manager of your choice (all of the tools used today can easily be handled using ","position":{"start":{"line":119,"column":1},"end":{"line":119,"column":1}},"key":"O88avUbqrn"},{"type":"inlineCode","value":"pip","position":{"start":{"line":119,"column":1},"end":{"line":119,"column":1}},"key":"xSqKQK0px4"},{"type":"text","value":")","position":{"start":{"line":119,"column":1},"end":{"line":119,"column":1}},"key":"pYmzYD3b86"}],"key":"CtgifI60su"}],"key":"zhTLPcXtAe"}],"key":"sDGy4V0rtK"},{"type":"code","lang":"console","value":"pip install -r requirements.txt","position":{"start":{"line":121,"column":1},"end":{"line":123,"column":1}},"key":"SwXeaeqFAF"},{"type":"list","ordered":true,"start":3,"spread":false,"position":{"start":{"line":125,"column":1},"end":{"line":130,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":125,"column":1},"end":{"line":126,"column":1}},"children":[{"type":"paragraph","position":{"start":{"line":125,"column":1},"end":{"line":125,"column":1}},"children":[{"type":"text","value":"Make a change to one of the files in the ","position":{"start":{"line":125,"column":1},"end":{"line":125,"column":1}},"key":"Fjk4xbUbZk"},{"type":"inlineCode","value":"content","position":{"start":{"line":125,"column":1},"end":{"line":125,"column":1}},"key":"oOxsYnvZ4K"},{"type":"text","value":" directory using a text editor.","position":{"start":{"line":125,"column":1},"end":{"line":125,"column":1}},"key":"vuEyl7Kd9O"}],"key":"N1RVapfLBL"}],"key":"EIvemjz3eQ"},{"type":"listItem","spread":true,"position":{"start":{"line":127,"column":1},"end":{"line":128,"column":1}},"children":[{"type":"paragraph","position":{"start":{"line":127,"column":1},"end":{"line":127,"column":1}},"children":[{"type":"text","value":"(optional) Commit the the change using Git and push it to the remote repository (this will trigger the GitHub Actions workflow and rebuild the website, which can be viewed at the same URL described above). If you go back to your repository and click on the ","position":{"start":{"line":127,"column":1},"end":{"line":127,"column":1}},"key":"JIZSkgiYLs"},{"type":"inlineCode","value":"Actions","position":{"start":{"line":127,"column":1},"end":{"line":127,"column":1}},"key":"PEBLo6YiDU"},{"type":"text","value":" tab you will see that the workflow is running to build and deploy your book. After a few minutes, you can refresh your book page and see your changes!","position":{"start":{"line":127,"column":1},"end":{"line":127,"column":1}},"key":"LhvkrmLplN"}],"key":"pTcnA3pial"}],"key":"NzcdtF4fCL"},{"type":"listItem","spread":true,"position":{"start":{"line":129,"column":1},"end":{"line":130,"column":1}},"children":[{"type":"paragraph","position":{"start":{"line":129,"column":1},"end":{"line":129,"column":1}},"children":[{"type":"text","value":"Build the book from source and serve it locally.","position":{"start":{"line":129,"column":1},"end":{"line":129,"column":1}},"key":"REAcCwdCiY"}],"key":"lHYgNBLgoC"}],"key":"ryyiYFrKxd"}],"key":"Qy6x2uevwv"},{"type":"code","lang":"console","value":"jupyter book start","position":{"start":{"line":131,"column":1},"end":{"line":133,"column":1}},"key":"w1n12nkzyS"},{"type":"list","ordered":true,"start":5,"spread":false,"position":{"start":{"line":135,"column":1},"end":{"line":136,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":135,"column":1},"end":{"line":136,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Preview the book in your browser at ","position":{"start":{"line":135,"column":1},"end":{"line":135,"column":1}},"key":"oI5WwUQdp8"},{"type":"link","url":"http://localhost:3000","position":{"start":{"line":135,"column":1},"end":{"line":135,"column":1}},"children":[{"type":"inlineCode","value":"http://localhost:3000","position":{"start":{"line":135,"column":1},"end":{"line":135,"column":1}},"key":"L5gQwGWUzU"}],"urlSource":"http://localhost:3000","key":"vLbvhitPzf"}],"key":"J4MZrktGVS"}],"key":"vPvsAcqEfk"}],"key":"DxJipqiJMY"},{"type":"admonition","kind":"tip","children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Tip","key":"SSkhKvG6U7"}],"key":"tuD8bNXTkh"},{"type":"paragraph","position":{"start":{"line":138,"column":1},"end":{"line":138,"column":1}},"children":[{"type":"text","value":"The localhost address may be different than ","position":{"start":{"line":138,"column":1},"end":{"line":138,"column":1}},"key":"DHMNwnUS5k"},{"type":"inlineCode","value":"3000","position":{"start":{"line":138,"column":1},"end":{"line":138,"column":1}},"key":"MUkjADOfS7"},{"type":"text","value":" (check the ","key":"ZeGw5Btoiy"},{"type":"abbreviation","title":"commmand line interface","children":[{"type":"text","value":"CLI","key":"RlZOSJ3nrk"}],"key":"eChesaFEyW"},{"type":"text","value":" output).","key":"q6dNVuXOzQ"}],"key":"ukgCPTafty"},{"type":"paragraph","position":{"start":{"line":140,"column":1},"end":{"line":140,"column":1}},"children":[{"type":"text","value":"Once the MyST server is running, it will automatically update as you make changes to the source.","position":{"start":{"line":140,"column":1},"end":{"line":140,"column":1}},"key":"vqEbxQQz5g"}],"key":"om76wq74xq"}],"key":"rTH3PMEPA6"}],"key":"FuxoKdpPal"},{"type":"tabItem","title":"Online","children":[{"type":"paragraph","position":{"start":{"line":145,"column":1},"end":{"line":145,"column":1}},"children":[{"type":"text","value":"To work online, you must “edit” a file by making a commit using GitHub’s online tools:","position":{"start":{"line":145,"column":1},"end":{"line":145,"column":1}},"key":"XjBmiEmPoT"}],"key":"E5BJ4YsUEt"},{"type":"list","ordered":true,"start":1,"spread":false,"position":{"start":{"line":147,"column":1},"end":{"line":150,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":147,"column":1},"end":{"line":147,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Click on the ","position":{"start":{"line":147,"column":1},"end":{"line":147,"column":1}},"key":"ngfxESUyvV"},{"type":"inlineCode","value":"index.md","position":{"start":{"line":147,"column":1},"end":{"line":147,"column":1}},"key":"okDwz3TCJs"},{"type":"text","value":" file in the Content folder","position":{"start":{"line":147,"column":1},"end":{"line":147,"column":1}},"key":"ZDfohnUIzH"}],"key":"oZ2qoAkMbv"}],"key":"Rhp1h5jlp9"},{"type":"listItem","spread":true,"position":{"start":{"line":148,"column":1},"end":{"line":148,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Click on the drop down icon next to the pencil icon and choose ","position":{"start":{"line":148,"column":1},"end":{"line":148,"column":1}},"key":"SZuCCcUthL"},{"type":"inlineCode","value":"open in github.dev","position":{"start":{"line":148,"column":1},"end":{"line":148,"column":1}},"key":"Kl9Zey0LdL"},{"type":"text","value":" This will start the GitHub development environment where you can edit the files directly in your browser.","position":{"start":{"line":148,"column":1},"end":{"line":148,"column":1}},"key":"u2hl4t1ZPx"}],"key":"yXNxOeBWYi"}],"key":"qTUTLlZo9U"},{"type":"listItem","spread":true,"position":{"start":{"line":149,"column":1},"end":{"line":150,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Edit the file by replacing the names with your own and commit your changes, see ","position":{"start":{"line":149,"column":1},"end":{"line":149,"column":1}},"key":"OsswXDX9pm"},{"type":"crossReference","position":{"start":{"line":149,"column":1},"end":{"line":149,"column":1}},"children":[{"type":"text","value":"Figure ","key":"t2jUFsLsoH"},{"type":"text","value":"5","key":"ZDTnzYDZHV"}],"identifier":"vid_3","label":"vid_3","kind":"figure","template":"Figure %s","enumerator":"5","resolved":true,"html_id":"vid-3","key":"VqWfhEEw0T"}],"key":"d8EkzoomaD"}],"key":"sD4QSbQYn6"}],"key":"xZbSaYorI3"},{"type":"container","kind":"figure","children":[{"type":"iframe","src":"https://www.youtube.com/embed/MIJUMsTEfzY?si=upISYp21twTtAIFs","key":"dG0ttUceCF"},{"type":"caption","children":[{"type":"paragraph","position":{"start":{"line":154,"column":1},"end":{"line":154,"column":1}},"children":[{"type":"captionNumber","kind":"figure","label":"vid_3","identifier":"vid_3","html_id":"vid-3","enumerator":"5","children":[{"type":"text","value":"Figure ","key":"YNtEbzBwIr"},{"type":"text","value":"5","key":"lhvLXxvbAW"},{"type":"text","value":":","key":"YInBbHLuaW"}],"template":"Figure %s:","key":"b67pnhu9X5"},{"type":"text","value":"Working directly in the GitHub development environment.","position":{"start":{"line":154,"column":1},"end":{"line":154,"column":1}},"key":"i5OPrFIHPf"}],"key":"xO65Z0H1lW"}],"key":"stLCCCAiB5"}],"label":"vid_3","identifier":"vid_3","enumerator":"5","html_id":"vid-3","key":"YcnphJr8OH"},{"type":"paragraph","position":{"start":{"line":157,"column":1},"end":{"line":157,"column":1}},"children":[{"type":"text","value":"Now, if you go back to your repository and click on the ","position":{"start":{"line":157,"column":1},"end":{"line":157,"column":1}},"key":"E8ATu2j54p"},{"type":"inlineCode","value":"Actions","position":{"start":{"line":157,"column":1},"end":{"line":157,"column":1}},"key":"LlXJby4OUA"},{"type":"text","value":" tab you will see that the workflow is running to build and deploy your book. After a few minutes, you can refresh your book page and see your changes!","position":{"start":{"line":157,"column":1},"end":{"line":157,"column":1}},"key":"M2Jq6psvsZ"}],"key":"mHFgOUzkwc"}],"key":"VppyC4PmwP"}],"key":"tsbSaD7fka"},{"type":"heading","depth":2,"position":{"start":{"line":161,"column":1},"end":{"line":161,"column":1}},"children":[{"type":"text","value":"Create a PDF export","position":{"start":{"line":161,"column":1},"end":{"line":161,"column":1}},"key":"ENHZE7zV8T"}],"identifier":"create-a-pdf-export","label":"Create a PDF export","html_id":"create-a-pdf-export","implicit":true,"key":"fW90wYqPua"},{"type":"paragraph","position":{"start":{"line":162,"column":1},"end":{"line":162,"column":1}},"children":[{"type":"text","value":"A clear advantage of ","key":"ne9cqKa33Y"},{"type":"abbreviation","title":"Jupyter Book 2","children":[{"type":"text","value":"JB2","key":"wasMhFe6c5"}],"key":"ttpnMGbAWY"},{"type":"text","value":" over JB1 is the ability to easily create a high quality PDF export of your book (as well as other formats). In a ","key":"WHYRBK0ZGT"},{"type":"link","position":{"start":{"line":162,"column":1},"end":{"line":162,"column":1}},"children":[{"type":"text","value":"later lesson of this workshop","position":{"start":{"line":162,"column":1},"end":{"line":162,"column":1}},"key":"NfIWleqxBW"}],"identifier":"pdfoutput","label":"pdfoutput","url":"/pdfoverview","internal":true,"dataUrl":"/pdfoverview.json","key":"tjPxGexvAL"},{"type":"text","value":", we will build a PDF locally and/or modify the GitHb Action workflow to automatically create a PDF export of your book using Typst when changes are pushed changes to your repository.","position":{"start":{"line":162,"column":1},"end":{"line":162,"column":1}},"key":"WlUolwKydB"}],"key":"jK9F6nEY0o"}],"key":"GnOnzL9NfL"}],"key":"SZZ7E1DMh7"},"references":{"cite":{"order":[],"data":{}}},"footer":{"navigation":{"prev":{"title":"Create your first Jupyter Book 2","url":"/your-turn","group":"Jupyter Book 2 Workshop Template"},"next":{"title":"Jupyter Book Fundamentals","url":"/firstedit","group":"Jupyter Book 2 Workshop Template"}}},"domain":"http://localhost:3000"}