JuliaDocs/Documenter.jl

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

Open

#1 778 ouverte le 11 mars 2022

Voir sur GitHub
 (6 commentaires) (1 réaction) (0 assignés)Julia (513 forks)batch import
Type: Pluginhelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Étudier comment makedocs() traite actuellement les fichiers .md, probablement dans le pipeline d'analyse du code source. L'issue suggère d'ajouter la prise en charge des fichiers .html (par exemple, de Quarto). Examiner les modules de chargement et de rendu des fichiers dans Documenter.jl. Examiner les commentaires de l'issue pour toute discussion antérieure ou implémentation proposée. Vérifier s'il existe des PR ou des branches ouvertes traitant de cette fonctionnalité.
Stack technique
html
Domaine
documentationtooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40