johko / computer-vision-course

This repo is the homebase of a community driven course on Computer Vision with Neural Networks. Feel free to join us on the Hugging Face discord: hf.co/join/discord
MIT License
370 stars 123 forks source link

Latex and <Tip> blocks seems to not render correctly #222

Closed lulmer closed 2 months ago

lulmer commented 4 months ago

Description: While accessing the preliminary rendered content of the "Welcome" unit in the computer vision course hosted at this link, @bellabf and I encountered two main issues that significantly impact the readability and educational value of the material.

  1. LaTeX Equations Not Displaying Correctly: The LaTeX equations embedded within the course content are not rendered properly. It appears that equations enclosed in single dollar signs $...$ or $$...$$ do not show up as expected. I'm not sure if the problem lies with the Markdown renderer or another aspect of the documentation infrastructure.

  2. <Tip> Block Quotes Not Visible: Additionally, the custom <Tip>...</Tip> block quotes intended to highlight important information or tips are not visible at all. This makes it difficult to distinguish essential pointers or notes that could enhance understanding of the course material.

Questions:

Possible Solutions:

Request: We are reaching out to the documentation team and the course maintainers to seek guidance on these issues.

Example: Here is a screenshot I took for one of the affected chapters (Unit13: Hyena). Unit 1: Images, Unit13: Hiera, and I suppose all the chapters that have equations/tips are also affected : image

bellabf commented 2 months ago

I believe this was solved by https://github.com/johko/computer-vision-course/pull/228, https://github.com/johko/computer-vision-course/pull/220 and others. The other problem with the spaces comes from the docbuilder (https://github.com/johko/computer-vision-course/pull/228#issuecomment-2006591074)

Maybe we can close this @johko?

lulmer commented 2 months ago

@bellabf indeed it has been fixed ! I close it