https://github.com/mgsisk/remark-lint-config

Opinionated remark-lint configuration for writing Markdown.
https://github.com/mgsisk/remark-lint-config

Last synced: 25 days ago
JSON representation

Opinionated remark-lint configuration for writing Markdown.

• Host: GitHub
• URL: https://github.com/mgsisk/remark-lint-config
• Owner: mgsisk
• License: isc
• Created: 2018-12-07T17:54:56.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-12-17T04:00:03.000Z (about 1 year ago)
• Last Synced: 2024-05-21T12:32:02.975Z (8 months ago)
• Language: JavaScript
• Size: 1.18 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md
  • Support: SUPPORT.md
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

        
# @mgsisk/remark-lint-config

Opinionated remark-lint configuration for writing Markdown.

[![Latest release][badge-release]][url-release]

[![Build status][badge-build]][url-build]

[![Code quality][badge-quality]][url-codacy]

[![Test coverage][badge-coverage]][url-codacy]

[![Maintainer funding][badge-funding]][url-funding]

The @mgsisk/remark-lint-config package includes an opinionated [remark-lint][]

configurations for writing Markdown.

## Installation

```sh

npm install --save-dev @mgsisk/remark-lint-config

```

## Usage

```yml

// .remarkrc.yml

plugins:

  - "@mgsisk/remark-lint-config";

```

[Support resources][] are available if you need help with this project. Refer to

individual plugin documentation for more information on how each works.

## Contributing

[Contributions][] are always welcome; please read the [code of conduct][]

before you begin. See the [changelog][] for notable project changes, and report

any [security][] concerns you find.

## Thanks

To the [contributors][] that help to build, fund, and maintain this project;

the [other works][] that have contributed to and inspired this project; and

anyone that has found this project useful.

## License

[ISC][]

[badge-build]: https://img.shields.io/github/actions/workflow/status/mgsisk/remark-lint-config/build.yml

[badge-coverage]: https://img.shields.io/codacy/coverage/368f6b6ae2f74c3e9f04550afd8820ce

[badge-funding]: https://img.shields.io/github/sponsors/mgsisk

[badge-quality]: https://img.shields.io/codacy/grade/368f6b6ae2f74c3e9f04550afd8820ce

[badge-release]: https://img.shields.io/github/v/tag/mgsisk/remark-lint-config?sort=semver

[changelog]: CHANGELOG.md

[code of conduct]: CODE_OF_CONDUCT.md

[contributions]: CONTRIBUTING.md

[contributors]: AUTHORS.md

[isc]: LICENSE.md

[other works]: THANKS.md

[remark-lint]: https://github.com/remarkjs/remark-lint

[security]: SECURITY.md

[support resources]: SUPPORT.md

[url-build]: https://github.com/mgsisk/remark-lint-config/actions?query=workflow%3Abuild

[url-codacy]: https://app.codacy.com/gh/mgsisk/remark-lint-config

[url-funding]: CONTRIBUTING.md#funding

[url-release]: https://github.com/mgsisk/remark-lint-config/releases