search

Seneca-ICTOER / Intro2C

Seneca College IPC144 Course Notes
https://ipc144.sdds.ca
Other
7 stars 52 forks source link

Consider using Mermaid for Markdown diagrams #173

Closed humphd closed 1 year ago

humphd commented 2 years ago

GitHub just added support for Mermaid in their Markdown, and it looks really cool. It's also compatible with Docusaurus, see https://sjwall.github.io/mdx-mermaid/docs/intro/

A bunch of the diagrams in the C notes could be done with this vs. SVG or images, and they'd render much better.

Genne23v commented 2 years ago

I'm not sure if we can keep all original intention with mermaid, this is how it looks from my initial drafting. Screen Shot 2022-11-11 at 9 38 20 AM It's not easy to customize everything. Please let me know if I can go ahead with this on every page.

humphd commented 2 years ago

I wouldn't make this about doing "every page" but rather try doing it on a single page so we can evaluate the process.

CC'ing @CameronGray1210 for input.

Genne23v commented 2 years ago

Let me complete one page with my best styling efforts. Please review if this is a desired way.

humphd commented 2 years ago

Yes, doing a small sample on one page is the right approach. Small, iterative changes are better than all-or-none.