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 admonition handling code #1752

Open
Remi-Gau opened this issue Mar 27, 2024 · 1 comment · May be fixed by #1768
Open

improve admonition handling code #1752

Remi-Gau opened this issue Mar 27, 2024 · 1 comment · May be fixed by #1768
Labels
formatting Aesthetics and formatting of the spec

Comments

@Remi-Gau
Copy link
Collaborator

Currently admonition removal deletes the entire admonition "directive" during the pdf build

!!! note "foo bar"

    LOREM ispum

becomes this

LOREM ispum

From personal experience (and seeing @oesteban work with them) it adds mental load when writing them by having to keep in mind this extra rule "don't put anything meaningful in the title of the admonition".


I could try to make this a bit nicer by making the code do this:

This:

!!! note "foo bar"

    LOREM ispum

becomes this

**Note**: foo bar
LOREM ispum

@oesteban @effigies @sappelhoff

Any thoughts?

@oesteban
Copy link
Collaborator

That would be a great start, and honestly, I am not sure the PDF rendering should get much further than that.

Perhaps it would be a better effort to set the correct HTTP metadata headers in the document so printing to PDF does generate a nice-looking document.

Markdown-based slides engines rely on the browser's printing feature to do that. I think CI/CD can run chrome or firefox headlessly and print out a PDF.

@Remi-Gau Remi-Gau linked a pull request Apr 11, 2024 that will close this issue
@Remi-Gau Remi-Gau added the formatting Aesthetics and formatting of the spec label Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
formatting Aesthetics and formatting of the spec
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants