Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2

markdownlint plugin for the asdf version manager
https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2

Last synced: about 1 month ago
JSON representation

markdownlint plugin for the asdf version manager

Awesome Lists containing this project

README

        

# asdf-markdownlint-cli2 [![Build][build-img]][build] [![Lint][lint-img]][lint]

[build]: https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2/actions
[build-img]: https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2/actions/workflows/build.yml/badge.svg
[lint]: https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2/actions
[lint-img]: https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2/actions/workflows/lint.yml/badge.svg

[markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) plugin for the
[asdf version manager](https://asdf-vm.com).

**Disclaimer**: the authors of this plugin are not affiliated with [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2);
for information purposes we show the license associated with that software:
[![markdownlint License][markdownlint-cli2-license-img]][markdownlint-cli2-license].

[markdownlint-cli2-license-img]: https://img.shields.io/github/license/DavidAnson/markdownlint-cli2.svg?label=markdownlint-cli2%20License&color=lightgrey
[markdownlint-cli2-license]: https://github.com/DavidAnson/markdownlint-cli2/blob/main/LICENSE

## Contents

- [Dependencies](#dependencies)
- [Install](#install)
- [Versioning](#versioning)
- [Readme](#readme)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [License](#license)

## Dependencies

- `bash`, `curl`, `tar`: generic POSIX utilities.
- `nodejs`: the Node.js JavaScript runtime.
- `npm`: a package manager for the JavaScript programming language.

## Install

Start by installing the plugin with:

```shell
asdf plugin add markdownlint-cli2 https://github.com/paulo-ferraz-oliveira/asdf-markdownlint-cli2.git
```

Now install the tool with:

```shell
asdf install markdownlint-cli2 latest
```

Check [asdf](https://github.com/asdf-vm/asdf)'s README for more instructions on how to
install and manage versions.

## Versioning

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Readme

We get inspiration for our README's format/content from
[Make a README](https://www.makeareadme.com/).

## Changelog

All notable changes to this project will be referenced from the [CHANGELOG](CHANGELOG.md).

## Contributing

Though this project is maintained by [paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira),
contributions are accepted and welcome. Check [CONTRIBUTING.md](CONTRIBUTING.md) for more.

## License

Check [LICENSE](LICENSE).