{"repo":"executablebooks/cookiecutter-jupyter-book","free":true,"listed":false,"github":"https://github.com/executablebooks/cookiecutter-jupyter-book","clone":"git clone https://github.com/executablebooks/cookiecutter-jupyter-book.git","description":"Cookiecutter template for a simple jupyter book","language":"TeX","stars":160,"topics":["jupyter-book","cookiecutter-template","python","workflow"],"license":"BSD-3-Clause","category":"workflow-automation","readme_excerpt":"Cookiecutter Jupyter Book A cookiecutter template for creating a simple Jupyter Book. See the rendered version of this cookiecutter template here. Template An example template created by this cookiecutter is shown below: Usage 1. Install Cookiecutter if you haven't installed it yet: 2. Use cookiecutter-jupyter-book to generate a Jupyter Book template and fill out the requested information (default templating values are shown in square brackets [] and will be used if no other information is entered): 3. Install the Jupyter Book package requirements from the requirements.txt file (it is recommended to do this in a virtual environment, e.g., using conda): 4. Build the HTML render of your Jupyter Book: 5. View your rendered book in my book/ build/html/index.html . 6. Make edits to your book by adding more content, updating the table of contents in my book/ toc.yml , and and/or by editing the configuration file my book/ config.yml . See the Jupyter Book documentation for more information on customizing your book. 7. cookiecutter-jupyter-book optionally comes with CI workflow files to help easily deploy your book online. A CI workflow file would have been included in your directory structure if you chose 1 - github or 2 - gitlab for Select include ci files: in Step 2 above. For example, if you chose 1 - github , when ready to deploy your book online: 1. Make sure your book builds locally as expected ( jupyter-book build my book/ ) and that you have updated the requirements.txt file","default_branch":null,"files":null,"tree":[],"storefront":"/r/executablebooks","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/executablebooks/cookiecutter-jupyter-book/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}