Skip to content

docs: mdformat description #368

Open
@fyliu

Description

@fyliu

Overview

We need a description for the mdformat tool used for format markdown files: what it does, how it compares to markdown lint, how to setup and use it with an example.

Action Items

  • create mdformat.md page in tools/
  • write description
    • what it does
    • how it compares to markdown lint
    • how to setup and use it
  • add example to format a file
  • add example to run it in pre-commit

Resources/Instructions

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    📋Prioritized Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions