- Create your notebooks in the
lecturesorexercisesfolder. The content of these folders is automatically converted to HTML. - Reference them either in the index or in other notebooks so they are reachable.
- The content of
mediaandslidesis automatically pushed to the LFS, so you can put your illustrations there (no heavy data). - You can locally test to build HTML pages using the building instructions (below).
- "Input icon" designates the icons used to indicate what the user should press/click to trigger an action (left click, ctrl+click, ...)
- To do that, an icons pack (CC0) is present in "media"
- To insert an icon use the following markdown:

- The "Kenney-" prefix is mandatory within the square brackets.
- The "xxx" part is up to you.
- "nnn" is to find in the icons pack folder.
- Some QuPath icons are present in "media/qp-icons".
- To insert a QuPath icon use the following markdown:

- The "QP " prefix is mandatory within the square brackets.
- The "xxx" part is up to you.
- "nnn" is to find in the QuPath icons folder.
- Tips, warning and notes must be in their own notebook cell.
- This kind of block is generated using the cell's tags in the IPYNB.
- In VS Code, you can do right-click > "add cell tag" once you are in rendering mode (not cell editing mode).
- Possible values (case sensitive):
- "tip"
- "warning"
- "note"
- Have a Python environment in which
nbconvertandbeautifulsoup4are installed, and activate it. - At the same level as
lectures,exercises, ... create a newbuilddirectory (don't jump into it). - Make sure that your terminal's curent directory is the one containing
build,lectures... - Run the command
sh ./build.sh
- Create a GitHub action to convert the slides to PDF.
- Write the installation tutorial for all requirements.