admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated intro page

Browse source
This commit is contained in:
Tom van Woudenberg 2024-02-26 09:41:59 +01:00
parent 63a5b9e7f0
commit d638f1c5a1
1 changed files with 1 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

22
book/intro.md
View file

@ -6,27 +6,7 @@ This is an introduction to Git, VS Code and Jupyter Books for teachers and teach
Robert created this list to keep track of things that should be in our manual. Especially the small problems we have run into in MUDE and other projects.
- use the right HTML tags for images (described {ref}`here <image-tag-example>`)
- watch out for `png` versus `PNG`
- trick for creating download link for PDFs (see Archive weekly summary pages); requires an `eval-rst` admonition, which can't be placed inside some objects (maybe someone can test this, and see if an inline option is available)
- 2 interesting comments from Quinten about MyST extensions in [this GL Issue](https://gitlab.tudelft.nl/mude/archive-2022/-/issues/25#note_163123)
(image-tag-example)=
### Example of image tag
This was found in the MUDE Archive, [Issue 29](https://gitlab.tudelft.nl/mude/archive-2022/-/issues/29).
It looks like the `figure` tag
```
<figure>
<IMG SRC='...'>
</figure>
```
is not supported. but the `img` tag is:
```
<img src="...">
```
see examples [here](https://jupyterbook.org/en/stable/content/figures.html) (no `figure` tag mentioned for HTML, only Markdown)
## Contact
If you encouter any issues, please contact Caspar Jungbacker (c.a.a.jungbacker@tudelft.nl).
If you encouter any issues, please contact Tom van Woudenberg, Robert Lanzafame or one of our TAs Caspar Jungbacker or Julie Kirsch at books-CEG@tudelt.nl.