hackforla / hackforla/peopledepot

docs: `mdformat` description

Open
#368 0 comments 0 reactions 0 assignees View on GitHub
complexity: medium feature: docs: PD team documentation PII: FALSE role: technical writing s: PD team size: 0.5pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### 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

- [mdformat repo](https://github.com/executablebooks/mdformat)
- [mdformat-mkdocs repo](https://github.com/KyleKing/mdformat-mkdocs)
- our [pre-commit page](http://localhost:8005/contributing/tools/pre-commit/#installation) - may need to fix link

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.