Skip to content

Optionally make build fail if there are bad links #1092

@rasapetter

Description

@rasapetter

Feature request

Make vuepress build fail if any link found in the markdown files is pointing in the wrong direction. Checking external URLs would be painful, so my suggestion is we would only check links pointing to other pages in the same vuepress instance (I've noticed that there is already a link checker in place for when you run vuepress dev).

What problem does this feature solve?

This would prevent people from accidentally introducing dead links into their docs.

What does the proposed API look like?

It should probably be opt-in (at least to start with), so perhaps something like vuepress build --validate-links

How should this be implemented in your opinion?

Are you willing to work on this yourself?**

Sure. Some pointers would be appreciated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs reproductionWaiting for a reproduction link (codepen, code sandbox, GH repos)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions