dotnet / dotnet/docfx

Add syntax for "unchecked" relative URL

Open
#676 16 comments 2 reactions 0 assignees View on GitHub
extensibility markdown
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

I'm currently assembling several docfx "mini-sites" together (for a project where the multi-versioning support wouldn't help). Occasionally, I need to cross-reference from one mini-site to another. I can do so via a regular href to the generated HTML, but I get a warning ("Invalid file link").

I definitely appreciate the warnings for other links (e.g. yml and md), but it would be nice to be able to tell docfx not to check a specific link, as I _know_ it won't be present at build time. (I have a later validation stage for that.)

Is there any existing syntax (ideally for both toc.yml and md files) that allows the target of a link to be unchecked?

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.