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

markdownlint-config-fluid

v0.1.8

Published

Shareable MarkdownLint config for the fluid project.

Downloads

1,067

Readme

markdownlint-config-fluid

License: BSD 3-Clause Latest Release NPM Package

Shareable markdownlint configuration for the Fluid Project.

Using

To use the markdownlint configuration provided by this module, add it as a dev dependency to your project:

npm install markdownlint-config-fluid --save-dev --save-exact

With markdownlint-cli

If you are using markdownlint-cli, you can pass this configuration to the CLI directly:

markdownlint --config=node_modules/markdownlint-config-fluid/index.js

With markdownlint-cli2

If you are using markdownlint-cli2, you can create a .markdownlintrc.js file with the following contents:

"use strict";

module.exports = require("markdownlint-config-fluid");

With grunt-markdownlint

If you are using Grunt and grunt-markdownlint, you can load the JSON configuration into Grunt as follows:

grunt.initConfig({
    markdownlint: {
        options: {
            config: grunt.file.readJSON("./node_modules/markdownlint-config-fluid/.markdownlintrc.json")
        }
    }
});

Developing

See the markdownlint documentation for full details on available rules.

Modifying configuration

To modify the markdownlint rules provided by this module, update the configuration in the .markdownlintrc.json file. See the markdownlint documentation for configuration options.

Testing

To test your changes locally, link the package globally on your system.

# Run from the markdownlint-config-fluid directory.
# Depending on your system, you may need to use sudo.
npm link

Add your linked module to the package you want to test in.

# Run in the root directory for the package with which you want to test the configuration.
npm link markdownlint-config-fluid

Remove the links to clean up the test settings.

# Run from the markdownlint-config-fluid directory.
# Depending on your system, you may need to use sudo.
npm unlink

# Run in the root directory for the package with which you tested the configuration.
npm unlink markdownlint-config-fluid

# Run the install again to ensure that all the dependencies are properly installed.
npm install

Releasing

This package uses Conventional Commits, enforced with commitlint. This facilitates releasing new versions of the package via Release Please. To cut a release, merge the current release pull request.

This will tag an appropriate semantic version based on the nature of the recent commits to the project and update the changelog.

You will then need to publish the updated version to the npm registry. This requires an npm account with appropriate maintainer permissions. To publish the package, run:

npm publish

For more information on publishing to npm, see the npm publish documentation.