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 Code Font in Documentation #4690

Closed
ehehela opened this issue Dec 25, 2024 · 7 comments · Fixed by #4691
Closed

Improve Code Font in Documentation #4690

ehehela opened this issue Dec 25, 2024 · 7 comments · Fixed by #4691
Labels
enhancement Feature requests and enhancements

Comments

@ehehela
Copy link
Contributor

ehehela commented Dec 25, 2024

I have noticed that the font used for code examples in the Makie documentation makes it difficult to distinguish between commas and periods. This issue hampers readability and understanding of the code. I suggest improving the font used in the documentation to make commas and periods more distinguishable, thereby enhancing the user experience.

Thank you for your attention and efforts!

@ehehela ehehela added the enhancement Feature requests and enhancements label Dec 25, 2024
@jkrumbiegel
Copy link
Member

Hm yeah I actually agree it's not a great font, seems to be the VitePress default. If you can find out how to change it, I'd appreciate a PR!

@ehehela
Copy link
Contributor Author

ehehela commented Dec 25, 2024

Sorry, I’m not sure how to change the font as I’m new to Julia. I’ve recently started learning Makie.jl, but I find the current document font tiresome and distracting.

@jkrumbiegel
Copy link
Member

It's not a Julia thing, it would be a change in the docs' css files. You could google how to do that for vitepress sites, which is the non Julia tool we're using

@ehehela
Copy link
Contributor Author

ehehela commented Dec 26, 2024

I found that changing the CSS code from --vp-font-family-mono: "Space Mono", Menlo, Monaco, Consolas, "Courier New", monospace to --vp-font-family-mono: Consolas, "Courier New", monospace; makes the code font clearer.

@ehehela
Copy link
Contributor Author

ehehela commented Dec 26, 2024

Maybe we can modify this line? Shall I make a pull request?

--vp-font-family-mono: "Space Mono", Menlo, Monaco, Consolas, "Courier New",

@jkrumbiegel
Copy link
Member

Ok this is current "Space Mono"

Image

Menlo

Image

Monaco

Image

Consolas

Image

I like both Menlo and Monaco more than Consolas, at least on my Macbook this renders weirdly thin. So maybe just remove "Space Mono" from the list which I agree doesn't have great comma/point separation and in general seems a bit too "unusual" for docs.

The line you found should be the right place to change this I think

@ehehela
Copy link
Contributor Author

ehehela commented Dec 26, 2024

I have created a PR. Thank you @jkrumbiegel .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature requests and enhancements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants