Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve syntax highlighting in docs #5

Open
cabralpinto opened this issue Aug 28, 2023 · 2 comments
Open

Improve syntax highlighting in docs #5

cabralpinto opened this issue Aug 28, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@cabralpinto
Copy link
Owner

cabralpinto commented Aug 28, 2023

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.

@cabralpinto cabralpinto added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Aug 28, 2023
@cauliyang
Copy link

cauliyang commented Sep 3, 2023

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
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants