question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Detect external broken links on build

See original GitHub issue

🚀 Feature

Partly inspired by #3048, it would be nice to detect external links in the Markdown docs and signal to the user that they are broken.

Ref projects:

Have you read the Contributing Guidelines on issues?

Yes

Motivation

If you want good docs, you probably don’t want broken links.

Pitch

We should signal users if any external links are invalid on build.

A by-pass flag would be helpful because there might be cases broken external links are ok (e.g. pages that anticipate a link to become valid later on).

This additional check would be really helpful. I’m suggesting this feature because I am building a docs site on top of Docusaurus and I found a need for this personally. I was actually going to use markdown-link-checker with CI. But if this can be built-in, then it saves a LOT of work.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
anshulrgoyalcommented, Aug 3, 2020

Here is my pr for assets check https://github.com/facebook/docusaurus/pull/3096

1reaction
anshulrgoyalcommented, Aug 3, 2020

@adrianmcli it is very easy to create a new remark plugin for it. I have created one for image and one for assets u can take a look.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to Find and Fix Broken Links (5 Methods) - Kinsta
The first method we recommend to find and fix broken links is to use a web-based SEO audit tool. Two of the most...
Read more >
How to Find and Fix Broken Links on Your Website
Step 1: Find broken links · Step 2: Create a report and track your changes · Step 3: Analyze data and decide which...
Read more >
How to Find and Fix Broken Links (to Reclaim Valuable "Link ...
Step #1: Finding ALL broken links on your site. For small websites, you can use Site Explorer to find all broken external links....
Read more >
How to Find and Fix Broken Links with Semrush
A broken link can severely impact the user experience of your website. Whether a user's browsing your site's pages or exploring external ......
Read more >
How To Find Broken Links Using The SEO Spider
1. Open up the SEO Spider, type or copy in the website you wish to crawl in the enter url to spider box...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found