-
Notifications
You must be signed in to change notification settings - Fork 480
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
Feature request: Can makedocs()
accept .html files instead of .md files?
#1778
Comments
There is a good workaround: in the YAML header simply specify: format:
commonmark:
variant: -raw_html Of course support for HTML docs would still be preferable since by setting For anyone interested in seeing an example that uses the workaround solution see the following:
Works well enough, but for some odd reason image captions are not showing? They are rendered in basic Markdown syntax, so not sure why they don't show up. |
Do you mean that the self-contained HTML file would be the whole thing that gets sent to the browser, or do you imagine that Documenter would still try to generate the sidebar etc. around the provided HTML? The former should kind-of work already, as anything not Markdown just gets copied over to the output directory, although you wouldn't get a link in the sidebar (tangentially related: #344). For the latter, you could wrap things in an at-raw block. Either way though, generating correct links in user-provided HTML is difficult (related: #921).
Hmm, it looks like we populate the |
Thanks @mortenpi and apologies for the late reply.
Indeed, I meant the latter, i.e. passing a single HTML file instead of .md - shame it doesn't work, but kind of expected that this would be tricky! As for this:
I think it would be really nice to have support for captions and cross-references like in Quarto and R Markdown. Again conscious that this may be easier said than done, but I guess that in an ideal world, Documenter would just accept .qmd documents and render single HTMLs through Quarto. |
To support the For the HTML inclusion, at-raw blocks (or at-eval blocks with |
Some sort of a Quarto integration would have to be done as a plugin, both to manage dependencies, but I also think it would be a bit too big to be maintained here. |
This may be a long shot, but I'm wondering if it would be possible to let
makedocs()
accept self-contained .html files instead of only .md files. I'm working on the docs for my package CounterfactualExplanations.jl and would love to use Quarto in order to have full support for cross-references (images, equations, citations, ...). I'm aware of some Julian ways to facilitate such things (e.g. DocumenterCitations.jl), but the ability to use Quarto would really be a catchall.The text was updated successfully, but these errors were encountered: