npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@salesforcedevs/sfdocs-no-relative-links-in-shared-md

v0.0.1

Published

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

Downloads

1,789

Readme

No relative cross references in markdown of specific folders.

What/why

We shouldn't allow relative links for cross references in markdown files for shared folder.

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.