JuliaDocs/Documenter.jl

Feature request: Can `makedocs()` accept .html files instead of .md files?

Open

#1778 aperta il 11 mar 2022

Vedi su GitHub
 (6 commenti) (1 reazione) (0 assegnatari)Julia (513 fork)batch import
Type: Pluginhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indagare su come makedocs() elabora attualmente i file .md, probabilmente nella pipeline di analisi del sorgente. L'issue suggerisce di aggiungere il supporto per file .html (ad esempio da Quarto). Esaminare i moduli di caricamento e rendering dei file in Documenter.jl. Rivedere i commenti dell'issue per eventuali discussioni precedenti o implementazioni proposte. Controllare se ci sono PR o branch aperti che affrontano questa funzionalità.
Tech stack
html
Dominio
documentationtooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Julia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40