Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@salesforcedevs/sfdocs-no-relative-link

Package Overview
Dependencies
Maintainers
0
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@salesforcedevs/sfdocs-no-relative-link

Validate the relative links in any folder and throw error/warning after check

  • 0.0.1-alpha
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
0
Weekly downloads
 
Created
Source

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.

FAQs

Package last updated on 19 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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc