Socket
Book a DemoInstallSign in
Socket

@salesforcedevs/sfdocs-orphan-link-linter

Package Overview
Dependencies
Maintainers
15
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@salesforcedevs/sfdocs-orphan-link-linter

Validate the orphaned file links and throw as error/warning

latest
npmnpm
Version
0.0.10
Version published
Maintainers
15
Created
Source

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.

FAQs

Package last updated on 24 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts