@salesforcedevs/sfdocs-no-relative-link

No relative cross references in markdown of specific folders.

What/why

We shouldn't allow relative links for cross references in markdown files for some folders (Shared folder as of now).

Recommendation

Always use absolute links for any specific markdown in Shared folder files. So all absolute links should start with /docs or we can use any external links.

More information

This linter takes up folder name as input. If there are any relative links within the specified folder it will throw error while validating as it doesn't have toc.yml entry.

This validation is added to make the yarn start and yarn validate consistent as the above scenario will create a broken link.

How to setup

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.