Excited to finally share my Jupyter Book course template!

firasm.github.io/jupyterbook_co…

In just 3 steps you can have your very own course website deployed and ready for your Jupyter Notebooks and markdown content! 😅whew!

Thanks @ProjectJupyter and Executable Books project! Image
To be clear, I am only a USER of the jupyterbook.org project - all credit to the devs.

It really is just two steps! Here is the repo template: github.com/firasm/jupyter…

(Thanks @TBeuzen for the assist with the GH Action!) Image
I’ll highlight a few features of this template repo that may be useful for teaching:

1. Support for executing code in a browser using thebe and @mybinderorg!

In an online class, you can do live code cell execution in Python-students can follow along with no setup on their end! Image
2. Structure for a 13-week course.

The book has file stubs for lecture notes/notebooks. All fully versioned using GitHub, automatically deployed using GH Actions to either GH or your server. Download pages of the site in PDF, link source code, or open in a @Mybinder notebook. Image
3. Examples of how to use IFrames to embed web content, @phet_sims, sli.do polls, videos, and other content.

Your students will appreciate all their course content in one place, and it’s easy for instructors to add or remove content! Image
4. Powerful built-in annotation and commenting features with @hypothes.is and utteranc.es. #annotatedsyllabus, course readings, and any other content.

Really neat features that were only added by the JupyterBook team in the last few days! Game changers for teaching! Image
5. Support for persistent checkboxes (via JS) so students can track their progress through notebooks, exercises and readings.

Add to-do lists, task lists, and checkboxes that persist between browser sessions using a WebStorage object (thanks @html5!) Image
6. The best part is, once you make the website, you can use the Redirect tool to embed it right into Canvas: literally *everything* happens in one place!

Students *should* have a seamless experience ...

(Fingers crossed it's as seamless as I claim, will report back). Image
Everything on this template is CC-BY-SA 4.0, use, edit, adapt, remix, share away! Support open education resources (#OER) and release your course materials!

I ❤️ the Jupyter Book project!

Also credit to @VincenzoCoia for first introducing me to this area with #bookdown.

/fin

• • •

Missing some Tweet in this thread? You can try to force a refresh
 

Keep Current with Firas Moosvi, PhD

Firas Moosvi, PhD Profile picture

Stay in touch and get notified when new unrolls are available from this author!

Read all threads

This Thread may be Removed Anytime!

PDF

Twitter may remove this content at anytime! Save it as PDF for later use!

Try unrolling a thread yourself!

how to unroll video
  1. Follow @ThreadReaderApp to mention us!

  2. From a Twitter thread mention us with a keyword "unroll"
@threadreaderapp unroll

Practice here first or read more on our help page!

Did Thread Reader help you today?

Support us! We are indie developers!


This site is made by just two indie developers on a laptop doing marketing, support and development! Read more about the story.

Become a Premium Member ($3/month or $30/year) and get exclusive features!

Become Premium

Too expensive? Make a small donation by buying us coffee ($5) or help with server cost ($10)

Donate via Paypal Become our Patreon

Thank you for your support!

Follow Us on Twitter!

:(