konrad11901 / mdl-snap

Snap for markdownlint

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Markdownlint

This is the snap for markdownlint, "A tool to check markdown files and flag style issues". It works on Ubuntu, Fedora, Debian, and other major Linux distributions.

Snap Status

The original repository can be found here.

Install

sudo snap install mdl

(Don't have snapd installed?)

Usage

cat file.md | mdl

Known issues

  • Trying to run mdl <file> will fail (permission error). Please use cat <file> | mdl instead. This problem doesn't occur when the file is located in home directory or on removable media.

Published for with 💝 by Snapcrafters

Remaining tasks

Snapcrafters (join us) are working to land snap install documentation and the snapcraft.yaml upstream so [Project] can authoritatively publish future releases.

  • Fork the Snapcrafters template repository to your own GitHub account.
  • Rename the forked Snapcrafters template repository
  • Update logos and references to [Project] and [my-snap-name]
  • Create a snap that runs in devmode
  • Register the snap in the store, using the preferred upstream name
  • Add a screenshot to this README.md
  • Publish the devmode snap in the Snap store edge channel
  • Add install instructions to this README.md
  • Update snap store metadata, icons and screenshots
  • Convert the snap to strict confinement, or classic confinement if it qualifies
  • Publish the confined snap in the Snap store beta channel
  • Update the install instructions in this README.md
  • Post a call for testing on the Snapcraft Forum - link
  • Ask a Snapcrafters admin to fork your repo into github.com/snapcrafters, transfer the snap name from you to snapcrafters, and configure the repo for automatic publishing into edge on commit
  • Add the provided Snapcraft build badge to this README.md
  • Publish the snap in the Snap store stable channel
  • Update the install instructions in this README.md
  • Post an announcement in the Snapcraft Forum - link
  • Submit a pull request or patch upstream that adds snap install documentation - link
  • Submit a pull request or patch upstream that adds the snapcraft.yaml and any required assets/launchers - link
  • Add upstream contact information to the README.md
  • If upstream accept the PR:
    • Request upstream create a Snap store account
    • Contact the Snap Advocacy team to request the snap be transferred to upstream
  • Ask the Snap Advocacy team to celebrate the snap - link

If you have any questions, post in the Snapcraft forum.

About

Snap for markdownlint

License:MIT License