dotnet / dotnet/docfx

[Bug] Shorthand Links are not checked for broken links

Open
#9,907 1 comment 0 reactions 0 assignees View on GitHub
xref
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

When using shorthand links such es `@versionhistorx` this link is not checked if is broken.

**To Reproduce**
Steps to reproduce the behavior:
1. Create a file `versionhistory.md`
2. Set the `uid: versionhistory` in the content
3. Create another file `reference.md`
4. In this file create the following:

```
## Sample
@versionhistory
@versionhistorx


```

5. run `docfx docfx.json --serve --open-browser`

**Expected behavior**
Using `
` will lead to warning, when the target does not exist:
`warning UidNotFound: 1 invalid cross reference(s) , "versionhistorx".`
This behavior would be expected as well, when using `@versionhistorx` which is not the case.

**Context:**
- OS: Windows 10
- Docfx version: 2.76.0

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.