Skip to content

Arbitrary flags for mdx #6416

@MisterDA

Description

@MisterDA

Desired Behavior

Although the mdx stanza in Dune covers a lot of possible interactions with ocaml-mdx, it doesn't cover all. It would be nice for easier debugging of mdx files to be able to add the verbose flag, for instance. There are also some customization options not covered by Dune: the syntax, various debugging flags, selecting subsections…
The interaction between the current stanzas and specifying custom flags could be tricky. Maybe user-defined flags should overwrite stanzas? Or should we look in user flags to make sure there's no duplication?
It would also make it easier to add new features to ocaml-mdx if the stanza doesn't catch up right away.

Example

The mdx stanza taken from current_examples:

(mdx
 (packages current_examples)
 (package current_examples)
 (files example_pipelines.md writing_plugins.md internals.md))

The same, with additional user-defined flags:

(mdx
 (packages current_examples)
 (package current_examples)
 (flags :standard --verbose --syntax=mli)
 (files example_pipelines.md writing_plugins.md internals.md))

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementmdxRelated to the internal mdx plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions