Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,21 +86,24 @@ A few pages are intentionally excluded (intro/landing pages that only contain na

## Link Checker

This repo includes [ethersphere/docusaurus-link-checker](https://github.com/ethersphere/docusaurus-link-checker) as a git submodule at `tools/docusaurus-link-checker`. After cloning, initialise it with:
The link checker scripts live in `scripts/` and are written in TypeScript. They require no additional installation beyond `npm ci` (which installs `tsx`).

### Usage

Run the checker against a local build:

```bash
git submodule update --init
npm run build # build the site first
npm run check:links # check the local build
```

### Usage

Run the checker from the repo root:
Or build and check in one step:

```bash
npm run check:links
npm run build:check
```

You will be prompted to choose local or live mode. Flags are passed through after `--`:
Flags are passed through after `--`:

```bash
npm run check:links -- --mode local
Expand All @@ -115,12 +118,6 @@ npm run check:links -- --mode local --no-external --threads 16
| `--no-external` | Skip external URL checking (local mode only) |
| `--threads N` | Number of concurrent HTTP threads (default: 8) |

To run the full build and then immediately check links:

```bash
npm run build:check
```

Reports are written to `link-reports/` (gitignored).

## Bumping Version
Expand Down
Loading
Loading