search

cabralpinto / modular-diffusion

Python library for designing and training your own Diffusion Models with PyTorch.
https://cabralpinto.github.io/modular-diffusion/
MIT License
266 stars 12 forks source link

Improve syntax highlighting in docs #5

Open cabralpinto opened 1 year ago

cabralpinto commented 1 year ago

Currently, we're using default Astro settings (Shiki with the github-dark theme). However, the syntax highlighting is clearly lacking, with many words not being highlighted. Useful link.

cauliyang commented 1 year ago

Hi @cabralpinto, How about we use https://www.mkdocs.org/ or https://www.sphinx-doc.org/en/master/ as the document system, both provide plenty of themes. For example, https://squidfunk.github.io/mkdocs-material/, https://sphinx-themes.org/. They also can integrate the docstring of code into the document directly. We do not need to bother with boilerplate code for html/css/js. MD/RST is enought to generate great docs. Moreover, we can customize the documentation using these document systems.

cabralpinto commented 1 year ago

Hi @cauliyang, thank you for your suggestion! However, the whole documentation site has already been built using Astro and I believe rebuilding it with a different system wouldn't be very productive :). So far the site works well and takes advantage of Astro's builtin markdown support, so that's not an issue either. I also appreciate that I could customize it to my liking, which is harder with preset themes. The only thing I'd like to change is how most of the words in the code don't get proper highlighting, which I believe can be done by just reconfiguring the Astro syntax highlighting options.