lint.yaml

name: Lint markdown files

on:
  push:
    branches:
      - main
    paths:
      - "**/*.md"
  pull_request:
    paths:
      - "**/*.md"

jobs:
  check-markdown-yaml:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Run Front Matter Linting
        uses: alasdairwilson/front-matter-lint@main
        with:
          directory: "."

  lint-python-codeblocks:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Lint Python Code Blocks in Markdown
        uses: OxfordRSE/lint-md-codeblocks@main
        with:
          directory: "."
          language: "python"

  lint-markdown:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: "20"

      - name: Install markdownlint-cli
        run: npm install -g markdownlint-cli

      - name: Lint Markdown files
        run: markdownlint -f  '**/*.md' --ignore '*/*/slides/*' --ignore README.md