Log in / Sign up
Chun Fei Lung
and 13 more...
Powered by Canny
Internal Links Checker
Check that internal links on the pages are not broken. Links often break when we restructure docs/move things around and it would be good if we had a system for detecting broken links (and even autofixing them).
April 28, 2019
marked this post as
August 19, 2020
Hi Yangshun, I have written a script for my docusaurus wiki that checks internal links every sunday. you can check it here:
Hope this can be useful in adding the feature! :)
June 13, 2020
Really grateful to see this. If we have a thousand visitors a month then which pack of site ground would you suggest to manage all the things.
March 20, 2020
I've attempted to integrate
configuration, but didn't have any luck. This functionality would be greatly appreciated.
March 19, 2020
I use textlint for validating various aspects of documents and make sure they conform to our style guide. I've integrated it with my V1 docusaurus based docs. Here's the link to textlint (they use docusaurus too!!! ):
There's a textlint rule that actually "validates" whether the links are valid or not.
The above rule is great for validating external links but I also needed to be able to validate internal links. My colleague used textlint framework and built another rule that can also validate "internal links". I'm using it in my V1 based repo right now and actually found several broken links in production docs:
The above rule not only validates internal links, but also anchor links within an internal link.
He also built another rule to validate links to images:
I highly recommend everyone to checkout textlint. There are lots of validations you can perform using existing rules built by the community.
I'm posting this here to discuss whether this feature should really be implemented as part of the V2 core or whether we can advocate textlint that can perform a lot of validations that are relevant to any documentations regardless of what docs generation tool users use or what version of docusaurus may be used.
Another validation tool I have incorporated into my docusaurus based repos is validating markdown standards.
Both of these validation tools (textlint, markdownlint) are part of my CI/CD pipeline so that docs are built & published only if validation passed.
June 7, 2019
Powered by Canny