https://github.com/pklaschka/ssblc

Static Site Broken Link Chacker: A broken-link checker for static sites, like the ones generated with docsify
https://github.com/pklaschka/ssblc

broken-link broken-link-finder broken-links ci docsify nodejs npm static-site

Last synced: 26 days ago
JSON representation

Static Site Broken Link Chacker: A broken-link checker for static sites, like the ones generated with docsify

• Host: GitHub
• URL: https://github.com/pklaschka/ssblc
• Owner: pklaschka
• License: mit
• Created: 2019-12-11T18:00:51.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-26T04:57:34.000Z (over 1 year ago)
• Last Synced: 2024-04-24T19:49:18.619Z (7 months ago)
• Topics: broken-link, broken-link-finder, broken-links, ci, docsify, nodejs, npm, static-site
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@pklaschka/ssblc
• Size: 745 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @pklachka/ssblc

Static Site Broken Link Checker

![CI Status Badge](https://github.com/pklaschka/ssblc/workflows/CI/badge.svg?branch=master)

A broken-link checker for static sites, like the ones generated with docsify that can get used, for example, for CI purposes on docsify docs (this is what I've developed it for).

It recursively checks internal links found on the static website (until every internal link is checked) and (without recursion) outgoing links. This is achieved by finding `href` attributes in the HTML, meaning also stylesheets included with `` get checked.

## Installation

You can either run it by just using `npx`, in which case you won't have to install it, or first install it with

```shell script

npm install -g @pklaschka/ssblc

```

## Usage

When you are in the folder of your static website (i.e., there is an `index.html` in this folder), simply run

```shell script

ssblc

```

after which the checker will begin its work.

To use it with `npx`, simply run

```shell script

npx @pklaschka/ssblc

```

Alternatively, you can also specify an absolute or relative path to the directory of the site, e.g., like this:

```shell script

ssblc ../my-site

```