feat(frontend): Improve highlighting of code samples#2538

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

JacobCoffee wants to merge2 commits intomain

base:main

Choose a base branch

fromhighlight-code-samples

Open

feat(frontend): Improve highlighting of code samples#2538

JacobCoffee wants to merge2 commits intomainfromhighlight-code-samples

Conversation

Copy link

Member

JacobCoffee commentedSep 12, 2024

What

Rebased on the latestmain fromImprove highlighting of code samples #1517

Add highlighting for the prompt marker in the code samples.

Refactor the html formatting so that the html tags are automatically generated and don't have to be written manually in the code samples sources.

Improve highlighting of code samples

c9c98c6

Add highlighting for the prompt marker in the code samples.Refactor the html formatting so that the html tags are automaticallygenerated and don't have to be written manually in the code samplessources.

JacobCoffee mentioned this pull request

Sep 12, 2024

Improve highlighting of code samples#1517

Closed

Copy link

timhoffm commentedSep 12, 2024•
edited
Loading

From original PR:

format_html() is actually a poor man's pygments, but I did not want to introduce this dependency. However, switching to pygments would be straight forward, if one wants to have full-fledged highlighting at some point in the future.

Not sure whether it was not the case at the time of the original PR or whether I just didn't know, but sphinx depends on pygments, so it's available in your doc build environment and you could use that instead of this manual approach.