{"version":3,"kind":"Article","sha256":"05e65618a92ac428229bd987ab5324501d398c8fb125671f4596cc0c570a24dc","slug":"intro","location":"/content/1_intro.md","dependencies":[],"frontmatter":{"title":"Introduction","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/1_intro.md","exports":[{"format":"md","filename":"1_intro.md","url":"/build/1_intro-2039210f5f95dcac6329526e29b437f1.md"}]},"mdast":{"type":"root","children":[{"type":"div","class":"font-light text-sm mb-4 updated-date-container","children":[{"type":"text","value":"Updated: 31 Oct 2025","key":"n46LoeJm8w"}],"key":"pZCHtlaQXB"},{"type":"block","children":[{"type":"paragraph","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"children":[{"type":"text","value":"This is the ","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"key":"eaPEzK2u35"},{"type":"emphasis","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"children":[{"type":"text","value":"Jupyter Book 2 Workshop Template,","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"key":"mwZPhAhHxp"}],"key":"lxsO3LfAwN"},{"type":"text","value":" designed to quickly and easily produce your own online interactive textbook as well as a high quality PDF enabled with Typst using ","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"key":"eD7RZC2xky"},{"type":"link","url":"https://next.jupyterbook.org/","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"children":[{"type":"text","value":"Jupyter Book 2","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"key":"nuA9dUSvii"}],"urlSource":"https://next.jupyterbook.org/","key":"HITCQt1vka"},{"type":"text","value":" technology.","position":{"start":{"line":3,"column":1},"end":{"line":3,"column":1}},"key":"le0RNve1Qy"}],"key":"ihRdobAUAs"},{"type":"paragraph","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}},"children":[{"type":"text","value":"This template:","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}},"key":"ARU6ByhwYe"}],"key":"gmhOIPABQ2"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":6,"column":1},"end":{"line":11,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":6,"column":1},"end":{"line":6,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"provides a ready-to-use Jupyter Book 2 structure for creating an online book (i.e., website),","position":{"start":{"line":6,"column":1},"end":{"line":6,"column":1}},"key":"JLQxvqyalL"}],"key":"rW988n1tcT"}],"key":"am59yryRDk"},{"type":"listItem","spread":true,"position":{"start":{"line":7,"column":1},"end":{"line":7,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"includes a number of lessons to get started understanding key components of a book and how to edit it,","position":{"start":{"line":7,"column":1},"end":{"line":7,"column":1}},"key":"Q7d7Cp4CFb"}],"key":"y1EWSQY9ir"}],"key":"SYFmVQFQ55"},{"type":"listItem","spread":true,"position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"includes a GitHub Action workflow to automatically build and deploy your book online,","position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}},"key":"imYS5KAWUa"}],"key":"H3WGerhquy"}],"key":"j96DKuSr2p"},{"type":"listItem","spread":true,"position":{"start":{"line":9,"column":1},"end":{"line":11,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"provides instructions for generating a high quality PDF with Typst using a ready-to-go template, then deploy it online automatically using GitHub Actions.","position":{"start":{"line":9,"column":1},"end":{"line":9,"column":1}},"key":"oOE9DAJeak"}],"key":"MxWkLS43Wh"}],"key":"RXT9zs5KSW"}],"key":"v2lICQDo4L"},{"type":"paragraph","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"children":[{"type":"text","value":"Hence, the template allows you to engage with ","key":"SZlPcXNtdA"},{"type":"abbreviation","title":"Jupyter Book 2","children":[{"type":"text","value":"JB2","key":"X0Z8OFMEji"}],"key":"D5F75XP7nu"},{"type":"text","value":" (and the underlying software MyST) ","key":"EljngZJODn"},{"type":"emphasis","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"children":[{"type":"text","value":"without installing any software on your own computer.","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"key":"TAoJMavXyR"}],"key":"GIsIscakmS"},{"type":"text","value":" You only need a web browser and a GitHub account (we provide details on how to work locally on your own computer). For those who are comfortable installing software locally (i.e., with a ","key":"TCDsl7RK2Y"},{"type":"abbreviation","title":"commmand line interface","children":[{"type":"text","value":"CLI","key":"oN0fwnQ9ZC"}],"key":"ISyZuykV5g"},{"type":"text","value":") and/or do not want to use the template book structure, use the ","key":"I8qSZeg35T"},{"type":"link","url":"/advanced-start","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"children":[{"type":"text","value":"Advanced Start","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"key":"wAw883Ea7g"}],"urlSource":"./advanced_start.md","dataUrl":"/advanced-start.json","internal":true,"protocol":"file","key":"Xh7BksX3TJ"},{"type":"text","value":" instructions, denoted with red hot 🌶.","position":{"start":{"line":12,"column":1},"end":{"line":12,"column":1}},"key":"ZtG77vP9Wa"}],"key":"UIKPi5y0iO"},{"type":"paragraph","position":{"start":{"line":14,"column":1},"end":{"line":14,"column":1}},"children":[{"type":"text","value":"As this document serves both as a template ","position":{"start":{"line":14,"column":1},"end":{"line":14,"column":1}},"key":"Njy20LgOJN"},{"type":"emphasis","position":{"start":{"line":14,"column":1},"end":{"line":14,"column":1}},"children":[{"type":"text","value":"and","position":{"start":{"line":14,"column":1},"end":{"line":14,"column":1}},"key":"toQFofdvML"}],"key":"rZiNfhWp5h"},{"type":"text","value":" a guide, it has the following structure:","position":{"start":{"line":14,"column":1},"end":{"line":14,"column":1}},"key":"dJTIkrZMQp"}],"key":"m7zzoCcDEk"},{"type":"list","ordered":true,"start":1,"spread":false,"position":{"start":{"line":16,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"A quick introduction to key Jupyter Book 2, MyST and Markdown concepts.","position":{"start":{"line":16,"column":1},"end":{"line":16,"column":1}},"key":"RhjG9V0mOF"}],"key":"FjRnXuiBmf"}],"key":"l76ZGICd4e"},{"type":"listItem","spread":true,"position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"A tutorial with several steps to introduce you to editing and building your own book.","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"QPJxnMV7Wo"}],"key":"GC4lNgDMHe"}],"key":"wz5MnDozZK"},{"type":"listItem","spread":true,"position":{"start":{"line":18,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"paragraph","children":[{"type":"text","value":"Additional resources, for example, ","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"key":"JnW8V4eRQY"},{"type":"link","url":"/advanced-start","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"children":[{"type":"text","value":"Advanced Start instructions","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"key":"wrngXeKAZ4"}],"urlSource":"./advanced_start.md","dataUrl":"/advanced-start.json","internal":true,"protocol":"file","key":"G5WtJ9YUBg"},{"type":"text","value":" and ","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"key":"J1I8WSX076"},{"type":"link","url":"/software","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"children":[{"type":"text","value":"Software","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"key":"y2Shv3GSIx"}],"urlSource":"./software.md","dataUrl":"/software.json","internal":true,"protocol":"file","key":"SRWA3NBcQC"},{"type":"text","value":".","position":{"start":{"line":18,"column":1},"end":{"line":18,"column":1}},"key":"GhES5yppyi"}],"key":"Dg4wpnuXhs"}],"key":"yJVLtJ4evo"}],"key":"AyERUgo8jo"},{"type":"admonition","kind":"note","children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Note","key":"qWczfWdA3K"}],"key":"z9nutd6S2K"},{"type":"paragraph","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"children":[{"type":"text","value":"The template and its content are not meant as a replacement of the documentation already available on the ","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"key":"Is0TTdJhN8"},{"type":"link","url":"https://next.jupyterbook.org/","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"children":[{"type":"text","value":"Jupyter Book 2 website","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"key":"q1kuhU5507"}],"urlSource":"https://next.jupyterbook.org/","key":"aFdb6NmGyS"},{"type":"text","value":" and the ","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"key":"YpqJPY2Yat"},{"type":"link","url":"https://mystmd.org/guide","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"children":[{"type":"text","value":"MyST website","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"key":"T85NYIMACb"}],"urlSource":"https://mystmd.org/guide","key":"TyqoVp8NqN"},{"type":"text","value":". It is designed to support new users of Jupyter Book 2 and MystMD, in particular for use in workshop settings where participants may not have time or ability to install the required software on a personal computer.","position":{"start":{"line":21,"column":1},"end":{"line":21,"column":1}},"key":"IrCqgY0NBZ"}],"key":"ju6jYLP5ls"}],"key":"JfBkVV9isR"},{"type":"myst","value":"```{warning} Enjoyment Warning!\nOnce you start building JB2 books, it is likely you will get hooked!\nFor instance, try changing this cell in the browser and see its output!\n```","key":"weonKf1Pv1"}],"key":"juyDxCpkie"}],"key":"iOPT5qCQIT"},"references":{"cite":{"order":[],"data":{}}},"footer":{"navigation":{"prev":{"title":"Jupyter Book 2 Workshop Template","url":"/","group":"Jupyter Book 2 Workshop Template"},"next":{"title":"Markdown Cheat Sheet","url":"/cheat-sheet","group":"Jupyter Book 2 Workshop Template"}}},"domain":"http://localhost:3000"}