JuliaDocs/Documenter.jl

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

Open

#1,778 opened on Mar 11, 2022

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

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 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.

Contributor guide

Research direction
Explore how makedocs() processes source files and identify the points where file extensions are filtered. Consider extending the pipeline to accept .html files and integrate with Quarto output.
Tech stack
html
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40