JuliaDocs/Documenter.jl

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

Open

#1.778 geöffnet am 11. März 2022

Auf GitHub ansehen
 (6 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Julia (513 Forks)batch import
Type: Pluginhelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Untersuchen, wie makedocs() derzeit .md Dateien verarbeitet, wahrscheinlich in der Quelltext Analysepipeline. Das Issue schlägt vor, Unterstützung für .html Dateien (z. B. von Quarto) hinzuzufügen. Die Dateilade und Rendermodule in Documenter.jl betrachten. Die Issue Kommentare auf frühere Diskussionen oder vorgeschlagene Implementierungen überprüfen. Prüfen, ob es offene PRs oder Branches gibt, die dieses Feature behandeln.
Tech Stack
html
Domain
documentationtooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Julia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40