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

Remove downlit to use built-in Quarto functionality instead #283

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

vincentarelbundock
Copy link
Collaborator

#278

This simplifies code and maintenance for altdoc

The autolink argument is removed, but was never on CRAN so it is not really a "breaking change".

@etiennebacher
Copy link
Owner

I lost track of whether this ever worked for other tools than Quarto but .autolink() also applies downlit when the tool is not Quarto. Are we sure we're not losing functionalities here?

@vincentarelbundock
Copy link
Collaborator Author

We are losing "functionality" (in quotes), but there was always a big caveat in the docs:

Note that the autolink argument works best for Quarto-based websites. mkdocs appears to ignore downlit annotations altogether. docute and docsify display downlit annotations, but CSS styling and code highlighting sometimes suffer.

And that's with me only testing other outputs very minimally. Honestly, that functionality always felt really half-baked to me, and I'd feel more comfortable not shipping it at all rather than having something we know doesn't work super well. Especially, when the path to improvement is not clear, and it's doubtful either of us will invest a lot of work on downlit+docsify.

@etiennebacher
Copy link
Owner

Sounds good to me. Also, as you said autolink never made it to CRAN so it's not really a loss

@vincentarelbundock vincentarelbundock merged commit 0dcc577 into etiennebacher:main Jul 4, 2024
5 checks passed
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.

2 participants