just slides

This commit is contained in:
James Turk 2024-09-25 23:57:11 -05:00
parent 7799db0e2f
commit d795795b89
6 changed files with 23 additions and 3 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

4
Justfile Normal file
View File

@ -0,0 +1,4 @@
slides:
for file in `ls */slides.md`; do \
marp $file; \
done

View File

@ -6,11 +6,27 @@ I will push notes to this repository throughout the quarter, so if you are keepi
Either make companion files in each directory, or keep your notes in a separate directory/notebook altogether.
## Table of Contents
I will create a directory for each topic, numbered in the order they're introduced.
Inside each directory, you're likely to find:
- `slides.md` - My slides in raw markdown.
- `slides.html` - My slides converted to a presentation. (using [`marp`](https://marpit.marp.app)) You can open this in your web browser (Type `open slides.html` from the command line.)
- `*-notebook.py` - These are marimo notebooks (see below).
Not every week will have slides & a notebook, but one or the other should generally exist.
Other files, such as images & data will be kept in the appropriate folder.
### Marimo Notebooks
Marimo notebooks are similar to Jupyter notebooks, but work much better with Git and have some other nice features I appreciate.
If you have ever looked at a Jupyter notebook file (.ipynb) in an editor, you know they are large JSON files, and once they are checked into Git changes become very difficult to track.
To interact with a notebook, run:
`uv run marimo edit <notebook-file>`
`uv run marimo`