markdownlint-config-fluid


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:

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

$3

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

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

$3

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

`js
"use strict";

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

$3

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

`js
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.

$3

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

$3

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

`bash


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.

`bash


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.

`bash


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
`

$3

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:

`bash
npm publish
``

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