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

[DOC]: Code blocks in libcu++ docs are hard to read #1481

Closed
1 task done
Nyrio opened this issue Mar 4, 2024 · 1 comment · Fixed by #1483
Closed
1 task done

[DOC]: Code blocks in libcu++ docs are hard to read #1481

Nyrio opened this issue Mar 4, 2024 · 1 comment · Fixed by #1483
Labels
doc Documentation-related items.

Comments

@Nyrio
Copy link
Contributor

Nyrio commented Mar 4, 2024

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

Currently, code blocks have a background color for the block but also one for the text. I find that this makes them hard to read.

My suggestion is to remove the text background color and make the block background color darker.

Before:

css_before

After:

css_after_2

In the CSS, one could remove:

div.highlighter-rouge, pre.highlight code {
  background-color: #111 !important;
}

And update:

.highlighter-rouge div.highlight
{ background: #1a1a1a; }

.highlighter-rouge div.highlight pre
{ background: #1a1a1a; }

edit: the rule needs to be more specific than defaults to override them

Example: https://nvidia.github.io/cccl/libcudacxx/ptx.html#stasync

@Nyrio Nyrio added the doc Documentation-related items. label Mar 4, 2024
@miscco
Copy link
Collaborator

miscco commented Mar 4, 2024

That looks indeed much better. Could you provide a PR for that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants