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

Allow passing extra args to code highlighter #1683

Merged
merged 1 commit into from Dec 2, 2021

Conversation

yuvipanda
Copy link
Contributor

I primarily want to allow for the possibility of line numbers
in HTML output. Pygments supports this natively, but we don't
have a way to pass arguments through to pygments.

A traitlet is added to allow passing arbitrary extra args
to the Pygments formatter, for Html and LaTeX. Should allow for
line number control and much more :)

This has been something folks have asked for for a while.

Ref ipython/ipython#5847
Ref #427
Ref yuvipanda/notebooksharing.space#34

I primarily want to allow for the possibility of line numbers
in HTML output. Pygments supports this natively, but we don't
have a way to pass arguments through to pygments.

A traitlet is added to allow passing arbitrary extra args
to the Pygments formatter, for Html and LaTeX. Should allow for
line number control and much more :)

This has been something folks have asked for for a while.

Ref ipython/ipython#5847
Ref jupyter#427
Ref yuvipanda/notebooksharing.space#34
@yuvipanda
Copy link
Contributor Author

Have to actually test this though.

@yuvipanda yuvipanda marked this pull request as ready for review December 1, 2021 19:32
@yuvipanda
Copy link
Contributor Author

I tested it and it works! All hail traitlets!

jupyter nbconvert a.ipynb --to html --Highlight2HTML.extra_formatter_options linenos=table

image

@yuvipanda
Copy link
Contributor Author

And I can call it from code like this:

    traitlets_config = {
        "Highlight2HTML": {"extra_formatter_options": {"linenos": "table"}}
    }
    exporter = HTMLExporter(
        # Input / output prompts are empty left gutter space
        # Let's remove them. If we want gutters, we can CSS them.
        exclude_input_prompt=True,
        exclude_output_prompt=True,
        extra_template_basedirs=[BASE_PATH],
        template_name="nbconvert-template",
        config=traitlets_config,
    )

Ready for review I think.

@yuvipanda yuvipanda requested a review from MSeal December 2, 2021 06:25
@SylvainCorlay
Copy link
Member

This looks good to me. Approving the PR.

@SylvainCorlay SylvainCorlay merged commit 9c1dcfc into jupyter:main Dec 2, 2021
@yuvipanda
Copy link
Contributor Author

Thanks a lot, @SylvainCorlay!

@blink1073 blink1073 added this to the 6.4 milestone Dec 28, 2021
yuvipanda added a commit to yuvipanda/nbconvert that referenced this pull request Dec 18, 2023
pygments emits line numbers via tables, with tr and td
elements (https://pygments.org/docs/formatters/#HtmlFormatter).
lxml's clean_html considers table, tr and td as safe elements,
but with jupyter#1854 they
are now considered unsafe. So instead of displaying line numbers,
the table, tr and td elements are escaped, and show up as literal
HTML if trying to enable line numbers via the method introduced
in jupyter#1683.

This PR adds table, tr and td as safe elements so that line numbers
can continue to work.

I know that there are probably plans to move away from bleach
(jupyter#1892), but this is
a small and focused change so hopefully doesn't need to block on
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants