Giter Club home page Giter Club logo

vuepress-plugin-check-md2's Introduction

vuepress-plugin-check-md2

vuepress check-md - Check dead links of markdown.

This plugin is powered by check-md made with ❤️ by @whxaxes.

Features

This plugin help check following types of dead links

  • Empty link.
  • Non-existed target markdown file.
  • Non-slugified hash.
  • Non-existed hash.
  • Prefer .md to .html (warn)

Install

yarn add -D vuepress-plugin-check-md2
# OR npm install -D vuepress-plugin-check-md

Usage

module.exports = {
  plugins: ['check-md2']
}
vuepress check-md2 [docsDir]

Passing Options

module.exports = {
  plugins: ['check-md2', {
    pattern: '**/*.md'
  }]
}

Options

Following options can also be passed via CLI options, e.g. vuepress check-md2 --fix

fix

  • Type: boolean
  • Default: false

Check and try to fix

pattern

  • Type: GlobPattern
  • Default: **/*.md

Glob pattern of resolved markdowns.

ignore

  • Type: GlobPattern
  • Default: **/node_modules

Glob pattern to specify paths from being checked.

exitLevel

  • Type: 'none' | 'info' | 'warn' | 'error'
  • Default: 'error'

Process exit level, default to error, other choice is warn and none, it will not exit if setting to none.

filter

  • TYpe: Function
  • Default: () => true

Filter function to filter out some links.

vuepress-plugin-check-md2's People

Contributors

strivingrabbit 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.