0.0.8 • Published 8 months ago
@sfdocs-internal/orphan-link-linter v0.0.8
Orphaned file link checker
About
This plugin serves the purpose of validating orphaned links within markdown files. An orphaned file, in this context, refers to a file that lacks a corresponding link to open it as a page via a URL. This situation arises when the file is not configured as part of the 'toc.yml' (Table of Contents YAML) file.
For instance, let's consider a scenario where 'A.md' contains a link to 'B.md'. If 'B.md' does not possess a designated URL for access, often due to the absence of an entry in the 'toc.yml' file, the plugin will generate a warning message in the following manner:
<row:col> warning Internal link `./B.md`` should be mentioned in a toc.yml configuration to use it as link.
Install & build
yarn install && yarn build
Pubilsh
yarn publish
Please make sure to push your changes (version number & other changes) to git once publishing is complete.