Skip to content

elaboration on how to use it #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slayoo merged 2 commits into from
May 14, 2026
Merged

elaboration on how to use it #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
244b426
elaboration on how to use it
slayoo May 14, 2026
ec4cdf4
Add new tools to the wordlist
slayoo May 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,8 @@ Perkel
ipynb
revealjs
plugin
Colab
PyCharm
Spyder
etc
url
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,13 @@

## <span class="emoji">🧭</span> How to use it?

<span class="emoji">📝</span> To use it, grab the [example `.ipynb` file](https://github.com/habemus-python/quarto-agh-slides/blob/main/slides.ipynb) and edit it
with your favourite Jupyter notebook tool.
<span class="emoji">📝</span> Everything is in a single file, so you can grab the [example `.ipynb` file](https://github.com/habemus-python/quarto-agh-slides/blob/main/slides.ipynb)
in any way (downloading the ipynb file, [downloading the repo contents](https://github.com/habemus-python/quarto-agh-slides/archive/refs/heads/main.zip),
cloning, [forking](https://github.com/habemus-python/quarto-agh-slides/fork), ...) and edit it with your favourite Jupyter notebook tool
(e.g., [Jupyter lab](https://jupyterlab.readthedocs.io), [VS Code](https://code.visualstudio.com/docs/datascience/jupyter-notebooks),
[PyCharm](https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html), [Colab](https://colab.google), [Spyder](https://docs.spyder-ide.org/current/plugins/notebook.html),&nbsp;...).
Forking the repo will additionally help you in setting up [CI workflows](https://github.com/habemus-python/quarto-agh-slides/tree/main/.github/workflows) for rendering on different platforms,
code linting, url- and spell-checks, etc.

<span class="emoji">🌐</span> To generate HTML files for presentation, do `quarto render slides.ipynb --execute --to revealjs`, the output (`slides.html` file) should look like this:

Expand Down
Loading