Skip to content

[api-documenter] Generated file names for constructors #1303

Open
@acchou

Description

@acchou

In some recent version of api-documenter (not exactly sure which version), markdown output files for constructors started to appear, and the filenames contain parentheses. E.g.:

docs/api/faastjs.statistics.(constructor).md

This appears fine to markdown but when run through other processing tools like Docusaurus these filenames appear to be not recognized by the markdown link => URL link transformation somewhere in the guts of the markdown to HTML transformer.

A concrete example is this class in the faast.js documentation: https://faastjs.org/docs/api/faastjs.statistics. The constructor link is broken because it retains the ".md" extension. Changing the URL to remove ".md" shows the correct page is accessible.

While this is likely a bug somewhere in Docusaurus or its dependencies, I think it's a bit unwise to generate markdown files with paren characters because they can be mishandled by downstream tools like this one.

Metadata

Metadata

Assignees

No one assigned

    Labels

    ae-ambiguous-idsThis issue belongs to a set of bugs tracked by PeteenhancementThe issue is asking for a new feature or design changeneeds designThe next step is for someone to propose the details of an approach for solving the problempriorityThe maintainers consider it to be an important issue. We should try to fix it soon.

    Type

    No type

    Projects

    Status

    AE/AD

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions