Skip to content

Integrating Documenter with parsers for non-markdown documents #1074

@non-Jedi

Description

@non-Jedi

Related issue: #821.

I've started writing a basic parser for org-mode
syntax
and am wondering what the
best way of integrating it with Documenter would be. Looking through
the unfamiliar codebase, would my best bet be to implement
Base.convert(Documenter.Utilities.Markdown2.MD, ::Org.Document)? The
problem then is that I would still need to override the
Documents.Page constructor. I could keep going down this path, but
I'd basically just be trying to shoe-horn things into an architecture
that's not currently well-built as far as I can see for multiple
document parsers.

Any thoughts on the changes that would be necessary on the Documenter
end for this to work? Or an alternative approach for integration on my
end that wouldn't require Documenter changes?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions