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

Documentation annotations don't render #3906

Closed
rodrigogiraoserrao opened this issue Dec 19, 2023 · 4 comments · Fixed by #3905
Closed

Documentation annotations don't render #3906

rodrigogiraoserrao opened this issue Dec 19, 2023 · 4 comments · Fixed by #3905
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@rodrigogiraoserrao
Copy link
Contributor

There are some annotations in code listings that aren't rendering correctly.
So far, I've identified these:

They look like this:

Screenshot 2023-12-19 at 12 32 57

For reference, the extra */ to the right of the only annotation that renders has been around for a long time now.

@rodrigogiraoserrao rodrigogiraoserrao added bug Something isn't working documentation Improvements or additions to documentation labels Dec 19, 2023
@TomJGooding
Copy link
Contributor

I found if you change the language shortcode from sass to css, the annotations seem to render as expected.

It must be something about how the lexer used for mkdocs handles comments in sass?

@TomJGooding
Copy link
Contributor

The docs for code annotations say that "Code annotations require syntax highlighting with Pygments"

Thankfully the Pygments website has a demo - you can see the results of my experimentation on this link.

Here's how the code annotations look after these changes:

image

@rodrigogiraoserrao rodrigogiraoserrao linked a pull request Jan 17, 2024 that will close this issue
@rodrigogiraoserrao
Copy link
Contributor Author

Fixed with #3905.

Copy link

Don't forget to star the repository!

Follow @textualizeio for Textual updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants