markdown¶

{
  "ignore": [
    "index.md",
    "future.md"
  ],
  "default": true,
  "MD013": false,
  "MD033": false,
  "MD024": false,
  "MD026": false,
  "MD041": false,
  "MD046": false,
  "MD045": false
}

# this calls a click command that runs markdownlint
# on my mac uses fli normally I use cli
alias zz='fli bujo zl'

Usage: cli.py bujo [OPTIONS] COMMAND [ARGS]...

  bullet journaling & todocli

Options:
  --help  Show this message and exit.

Commands:
  zl         markdownlint

@cli.command()
def zl():
    """markdownlint"""
    cmd = "npx markdownlint 'docs/*.md' --config .markdownlint.json"
    os.system(cmd)

name: markdownlint

on: [push, pull_request]

jobs:
  markdownlint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      - name: Install dependencies
        run: npm install markdownlint-cli
      - name: Run markdownlint
        run: npx markdownlint 'docs/index.md' --config .markdownlint.json --ignore docs/*.md

Usage: markdownlint [options] <files|directories|globs>

MarkdownLint Command Line Interface

Options:
  -V, --version                               output the version number
  -c, --config [configFile]                   configuration file (JSON, JSONC, JS, or YAML)
  -d, --dot                                   include files/folders with a dot (for example `.github`)
  -f, --fix                                   fix basic errors (does not work with STDIN)
  -i, --ignore [file|directory|glob]          file(s) to ignore/exclude (default: [])
  -j, --json                                  write issues in json format
  -o, --output [outputFile]                   write issues to file (no console)
  -p, --ignore-path [file]                    path to file with ignore pattern(s)
  -q, --quiet                                 do not write issues to STDOUT
  -r, --rules  [file|directory|glob|package]  include custom rule files (default: [])
  -s, --stdin                                 read from STDIN (does not work with files)
  --enable [rules...]                         Enable certain rules, e.g. --enable MD013 MD041 --
  --disable [rules...]                        Disable certain rules, e.g. --disable MD013 MD041 --
  -h, --help                                  display help for command