mirror of
https://github.com/ivuorinen/base-configs-markdownlint.git
synced 2026-03-03 12:54:44 +00:00
Ismo Vuorinen
9e10b3e2b2
Replace secrets.PAT with secrets.GITHUB_TOKEN in publish.yml so semantic-release can comment on PRs/issues using the built-in token scoped by job-level permissions. Set top-level permissions to empty object across all workflows to follow the principle of least privilege, relying on job-level permissions blocks instead.
@ivuorinen/markdownlint-config
ivuorinen's shareable configuration for
MarkdownLint.
Table of Contents
Installation
Install this config as a devDependencies:
# npm
npm install @ivuorinen/markdownlint-config --save-dev
# Yarn
yarn add @ivuorinen/markdownlint-config --dev
After installing it, a .markdownlint.json file will be created automatically in the project's root folder with the following configuration:
{
"extends": "@ivuorinen/markdownlint-config"
}
Documentations
Read the MarkdownLint docs for more information.
Contributing
If you are interested in helping contribute, please take a look at our contribution guidelines and open an issue or pull request.
Changelog
See CHANGELOG for a human-readable history of changes.
License
Distributed under the MIT License. See LICENSE for more information.