vuepress icon indicating copy to clipboard operation
vuepress copied to clipboard

Optionally make build fail if there are bad links

Open rasapetter opened this issue 6 years ago • 4 comments

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.

rasapetter avatar Dec 10 '18 10:12 rasapetter