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

Link functions #153

Closed
wants to merge 9 commits into from
Closed

Link functions #153

wants to merge 9 commits into from

Conversation

etiennebacher
Copy link
Owner

@etiennebacher etiennebacher commented Nov 24, 2023

Close #68

Maybe quarto does that for HTML docs (including quarto website) but not for markdown output. Need to pass via downlit::downlit_md_path() which takes a couple of seconds per file.

We lose the code block formatting, might be able to put it back by wrapping all <pre> in <div class="pre-wrapper" data-lang="r"> in docute.

  • fix formatting of code blocks
  • check on other docs generators

@vincentarelbundock
Copy link
Collaborator

Do we really need this? downlit seems like a pretty big dependency and code complication for something that feels like a fringe feature...

Or maybe it should be optional?

@etiennebacher
Copy link
Owner Author

I think this is useful and it was also requested in polars. This can definitely be a post-processing script instead of a built-in thing, but we should "advertise" it or make it easy to discover by users

@eitsupi
Copy link
Contributor

eitsupi commented Dec 4, 2023

Maybe quarto does that for HTML docs (including quarto website) but not for markdown output.

That's right. quarto-dev/quarto-cli#3777

@etiennebacher
Copy link
Owner Author

This probably wouldn't work for mkdocs. Basically mkdocs build does its own thing and generate their HTML file for each markdown file. Even if we could highlight everything in the md file, it would probably be removed by mkdocs.

I won't work on this any time soon so I'd rather close this

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.

Function calls in vignettes could link to the man page
3 participants