JuliaDocs/Documenter.jl

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

Open

#1.778 aberto em 11 de mar. de 2022

Ver no GitHub
 (6 comments) (1 reaction) (0 assignees)Julia (513 forks)batch import
Type: Pluginhelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigar como makedocs() atualmente processa arquivos .md, provavelmente no pipeline de análise de código fonte. A issue sugere adicionar suporte a arquivos .html (por exemplo, do Quarto). Examine os módulos de carregamento e renderização de arquivos no Documenter.jl. Revisar os comentários da issue para qualquer discussão anterior ou implementações propostas. Verificar se há PRs ou branches abertos abordando este recurso.
Pilha de tecnologia
html
Domain
documentationtooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Julia
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40