Skip to content

Improve autolink to files in MooseDocs #14883

Open
@aeslaughter

Description

@aeslaughter

Reason

Currently, syntax like [foo.i] will automatically create a link with popup to the source code, the mechanism for this is fragile because it is required to fall through for traditional markdown shortcut syntax.

Design

The autolink.py extension of MooseDocs should define a command for this rather than trying to be automatic: [!file](foo.i)

Impact

The documentation for moose and the apps will need to be updated, but the current method can be deprecated first while the update happens.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C: DocumentationGood first issueP: normalA defect affecting operation with a low possibility of significant effects.T: taskAn enhancement to the software.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions