Is it possible to check internal references to prevent broken/dead references?

[karlicoss]

Description

Consider the following simple quarto document:

---
format:
  html:
    toc: true
    toc-depth: 3
    anchor-sections: true
---

## Installing package

Instructions to install package

## Instructions for developers {#instructions-dev}

More instructions

## Misc

To install package, see [this](#installing-package)

To develop package, see [this](#instructions-dev)

I want to reference to some sections of the document throughtout it.

My concern is that

• if I rename a section (E.g. "Installing package", the implicit reference #installing-package would silently break
• if I make a typo in explicitly named reference, likewise, the links silently breaks with no indication from Quarto

Is it possible to enable some sort of strict mode to validate these during quarto render?

There are a couple of issues that mention broken links, but I feel like they are referring to external URLs? #1319 #2665

Thanks!

[cscheid]

There are a number of external tools you can use, but currently nothing built in to Quarto itself.

[karlicoss]

Thanks! Any particular recommendations that people use?
And do you think it would make sense as some sort of quarto plugin?

[fredguth]

One way is to create a post-render python script that checks that.