Skip to content

Support in-repo links, with verification and output-dependent conversion #431

Open
@behnam

Description

@behnam

While updating the new Cargo manual and preparing it for a release, I realized one big part of the work I was doing was to make sure the internal links are valid, after moving many pages around.

This made me realize that we don't have link verification for in-repo links, and partly it's because of the fact that the MD source files are linking to the HTML output files, but not to the respective MD source files.

Also, there's the fact that if there's ever any other output type, the internal links will be broken.

So, wondering if supporting in-repo links as link-to-source, plus link verification and output-dependent conversion, is something that's already in the plans for mdbook.

Example

Input

index.md

See the [first chapter](first/index.md).

This would error if first/index.md doesn't exist.

Output

If no errors, it converts the link to the HTML file.

index.html

[...]
<p>See the <a href="first/index.html">first chapter</a>.</p>
[...]

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-TestsArea: `mbdook test` related tests

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions