Skip to content

Commit

Permalink
Add useful packages list to README with links to ShortCodes and Markd…
Browse files Browse the repository at this point in the history
…ownLiteral
  • Loading branch information
eford authored Sep 24, 2024
1 parent ca8cca8 commit f553abb
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
# PlutoTeachingTools

This package provides several functions that are useful in Pluto notebooks used for teaching and making tutorials. The initial version merely borrowed functions from modules and/or homeworks from the excellent MIT course, [Introduction to Computational Thinking
Math from computation, math with computation (Spring 2021)](https://computationalthinking.mit.edu/Spring21/). Since then, there have been several additions from various other packages and issues.
Math from computation, math with computation (Spring 2021)](https://computationalthinking.mit.edu/Spring21/). Since then, there have been several additions from various other packages, issues, and contributors.

See the **[example notebook](https://juliapluto.github.io/PlutoTeachingTools.jl/example.html)** for functions provided.
Several functions have optional arguments that aren't (yet?) demonstrated in the example notebook.

I encourage others to improve and/or contribute new functions that are of value to other educators. Pull Requests welcome. (Breaking PRs will usually be delayed until the end of the academic semester for the maintainer.)
Others are encouraged to improve and/or contribute new functions that are of value to other educators (in either formal or informal settings). Pull Requests welcome, but please be patient when we are slow to review/merge PRs.

# Other useful packages for Pluto notebook tutorials
There are several existing package that also provide specific useful features. We list them below to help other educators discover them
- [PlutoUI](https://github.com/fonsp/PlutoUI.jl): widgets
- [ShortCodes.jl](https://github.com/hellemo/ShortCodes.jl): embed DOIs, YouTube, Tweets, etc.
- [PlutoLinks.jl](https://github.com/JuliaPluto/PlutoLinks.jl): include code from separate files.
- [MarkdownLiteral.jl](https://github.com/JuliaPluto/MarkdownLiteral.jl): more powerful markdown (interpolation, html, string attributes...)
- [LaTeXStrings.jl](https://github.com/JuliaStrings/LaTeXStrings.jl): easily include LaTeX

If you find yourself often including other packages, please consider adding them to the list above.

# Courses/Sites using PlutoTeachingTools
- [Astroinformatics Summer School (2022)](https://github.com/Astroinformatics/SummerSchool2022)
- [Astroinformatics Summer School](https://github.com/Astroinformatics/SummerSchool2022)
- [Introduction to Computational Thinking](https://computationalthinking.mit.edu/Fall24/)
- [Data Science Applications for Exoplanets](https://github.com/PsuAstro497/Fall2022)
- [High-Performance Computing for Astropysics](https://psuastro528.github.io/Fall2023/)
- [Julia programming for Machine Learning](https://github.com/adrhill/julia-ml-course)
- [Máquinas Elétricas II](https://ricardo-luis.github.io/isel-me2/Fall23/)

If you are using PlutoTeachingTools in a course/workshop and your notebooks are public (i.e., useful for others drawing inspiration), please consider adding them to the list above.

# Acknowledgements
- [Pluto](https://github.com/fonsp/Pluto.jl)
- [PlutoUI](https://github.com/fonsp/PlutoUI.jl)
- [PlutoLinks.jl](https://github.com/JuliaPluto/PlutoLinks.jl)
- [PlutoThemes.jl](https://github.com/JuliaPluto/PlutoThemes.jl)
- PlutoThemes.jl (repo move/no longer avaliable?)
- Some material on this website is based on "Computational Thinking, a live online Julia/Pluto textbook, https://computationalthinking.mit.edu"

## Contributors
Expand All @@ -31,4 +41,4 @@ I encourage others to improve and/or contribute new functions that are of value
- [mathutopia](https://github.com/mathutopia): Chinese
- [kagalenko-m-b](kagalenko-m-b): Russian
- [Several more users](https://github.com/JuliaPluto/PlutoTeachingTools.jl/graphs/contributors)

0 comments on commit f553abb

Please sign in to comment.