Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bidoubiwa/dead-links-logger


https://github.com/bidoubiwa/dead-links-logger

Last synced: 7 days ago
JSON representation

Awesome Lists containing this project

README

        

## Meilisearch docs crawler

very basic crawler to catch dead links.

### Setup

```

npm install
```

### Simple usage

```
npm run start
```

By running the script like this, the default URL is: `https://meilisearch-staging.vercel.app/docs` and the default `URL` path name is `/docs`.

### Change the starting URL

You can change the starting url and the url path by providing it as arguments when calling the script.

```
npm run start "https://meilisearch.com/docs" "/docs/"
```

### Logs

Dead links information are both outputed in the standard output and written in a file named `dead-links.json`