Git Product home page Git Product logo

mdqc's Introduction

Markdown Quality Checker

The Markdown Quality Checker is a lightweight tool designed to check the quality of your Markdown files. It offers several useful features to help you maintain the quality of your Markdown documents.

Features

  1. HTTP Links Checking:

    • This feature checks that all HTTP links in your Markdown files work correctly. It detects broken links and allows you to fix them quickly.
  2. Image Links Checking:

    • The Markdown Quality Checker also verifies all links to images in your Markdown files. It ensures that these links point to valid and accessible images.
  3. Image Compression Checking:

    • This feature checks if all images included in your Markdown files are compressed. It helps you reduce the size of your Markdown documents by compressing uncompressed images.

Installation

To install the Markdown Quality Checker, you need to have Go installed on your system. Once Go is installed, you can use the following command:

go install github.com/dim-ops/mdqc

Usage

After installing the tool, you can run it using the following command in the directory containing your Markdown files:

mdqc

For advanced usage, you can specify the path to a specific Markdown file or a directory containing multiple Markdown files to check:

mdqc link -p path
mdqc img -p path -i imgPath
mdqc compress -p imgPath

Contributing

Contributions are welcome! If you have any ideas to improve the Markdown Quality Checker or if you want to add new features, feel free to open a Pull Request.

License

This project is licensed under the Apache License.

mdqc's People

Contributors

dim-ops avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.