Jrmoulckers/root relative link support - Githubissues

Ellerbach / docfx-companion-tools

A suite of tools, pipelines templates to take the very best of DocFX

MIT License

66 stars 19 forks source link

Jrmoulckers/root relative link support #14

Closed jrmoulckers closed 1 year ago

jrmoulckers commented 1 year ago

Changes:

Added support for links relative to root directory (i.e.: ~/link/to/index.md)
Added check for invalid docfolder and warning presented to user
- Needed in the case of root relative links - invalid docfolder renders them invalid
Added E2E scenario to DocExamples of a link relative to the DocFX project root

Links:

Issue #12

Tests:

Validated on MS team's documentation (heavily populated with root relative links)
Validated on DocExamples project with added scenario:
- Validates changes on DocExamples project: valid.txt
- Validates changes on DocExamples project: invalid.txt
- Locally added invalid root-relative link ~/userdocs/hello.md inside file DocExamples/docs/markdown-creation.md

TODO:

Add labels: Bug, Feature