Giter Club home page Giter Club logo

mdformat-action's Introduction

mdformat-action

Custom action for linting markdown files using mdformat.

Usage

Add the following workflow file to run the action:

# .github/workflows/mdformat.yml
name: Mdformat Action
on:
  - pull_request
jobs:
  mdformat:
    name: Mdformat Action
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Mdformat Action
        uses: ydah/mdformat-action@main
        with:
          number: true
        env:
          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Inputs

file_or_dir

  • File or Directory to do mdformat on.
  • default: .
  • optional

number

  • Apply consecutive numbering to ordered lists.
  • default: false
  • optional

wrap

  • Paragraph word wrap mode.
    • keep
    • no
    • INTEGER
  • default: keep
  • optional

end_of_line

  • Output file line ending mode.
    • lf
    • crlf
    • keep
  • default: lf
  • optional

auto_correct

  • Adding commit by autocorrect for mdformat.
  • default: false
  • optional

mdformat-action's People

Contributors

bquorning avatar dependabot[bot] avatar ydah avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

bquorning

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.