TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Show HN: Deadlinks Documentation Checker

4 点作者 butuzov超过 5 年前

1 comment

butuzov超过 5 年前
Author here. I tried to work with kubeflow[1] project this summer, and i got a lot of 404 reading it&#x27;s documentation, which outranged me a bit. I wrote two functions php script and checked kubeflow site for deadlinks, made a few PR and hopefully fix the situation a bit. During hacktoberfest I made a tool called a deadlinks[2] (I am kinda bad in naming things), and start checking different project documentation for this kind of error (hey guys if you remember me - cheers!). I have discovered that there are (almost) no documentation without such errors. Every single one has it (except hashicorp tools, they are good!).<p>I start spending more time trying to improve deadlinks, and define use cases. Currently, I am working more on the kubenetes website and deadlinks swinging back and forth, and I think we are ready to be used.<p>I made simple documentation[3] so you can check examples and how this tool can be integrated into existing ci&#x2F;cd systems.<p>How can it be useful for your opensource project&#x2F;static website?<p>1. You can check it on broken links during CI.<p>2. You can apply it to a folder with files or to a server (standalone or ssg powered).<p>3. If you switching SSG you can check what will be the difference in terms of a number of broken links.<p>4. It&#x27;s available as pip package, brew and docker image.<p>[1] <a href="https:&#x2F;&#x2F;kubeflow.org" rel="nofollow">https:&#x2F;&#x2F;kubeflow.org</a><p>[2] <a href="https:&#x2F;&#x2F;github.com&#x2F;butuzov&#x2F;deadlinks" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;butuzov&#x2F;deadlinks</a><p>[3] <a href="http:&#x2F;&#x2F;deadlinks.readthedocs.io&#x2F;" rel="nofollow">http:&#x2F;&#x2F;deadlinks.readthedocs.io&#x2F;</a>