https://github.com/olcaymeteozdemir/markdownlint-config-core

Custom MarkdownLint settings as an extensible shared config.
https://github.com/olcaymeteozdemir/markdownlint-config-core

markdown markdownlint markdownlint-config

Last synced: 3 days ago
JSON representation

Custom MarkdownLint settings as an extensible shared config.

• Host: GitHub
• URL: https://github.com/olcaymeteozdemir/markdownlint-config-core
• Owner: OlcayMeteOzdemir
• License: mit
• Created: 2022-11-09T18:50:51.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-22T10:08:18.000Z (over 1 year ago)
• Last Synced: 2024-09-24T21:15:35.621Z (3 days ago)
• Topics: markdown, markdownlint, markdownlint-config
• Language: JavaScript
• Homepage:
• Size: 50.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# markdownlint-config-core

Custom MarkdownLint settings as an extensible shared config.

## Installation

If using npm version 5+:

```bash

npx install-peerdeps --dev @meteozdemir/markdownlint-config-core

```

If using npm version version < 5:

```bash

npm install -g install-peerdeps

install-peerdeps --dev @meteozdemir/markdownlint-config-core

```

If want to install manually without install-peerdeps CLI:

```bash

npm i -D @meteozdemir/markdownlint-config-core markdownlint-cli

```

## Usage

A `.markdownlint.json` file will be automatically created in the root of your project with:

```json

{

    "extends": "@meteozdemir/markdownlint-config-core"

}

```

If the file is not created automatically by any reason, simply create a `.markdownlint.json` file in the root of project and copy code above.

## Rule Override

Add any rule you want to override to `.markdownlint.json` file.

```json

{

    "extends": "@meteozdemir/markdownlint-config-core",

    // ...

    "heading-increment": false,

    "list-indent": false

}

```