docs: `mdformat` description
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Create tools/mdformat.md and first read the mdformat and mdformat-mkdocs repositories, then inspect the existing pre-commit page and its installation link. Done means the page explains mdformat, compares it with markdown lint, documents setup and use, and includes file-formatting and pre-commit examples.
Written by the indexing model from the issue text.
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
- mdformat-mkdocs repo
- our pre-commit page - may need to fix link
- Dominant language
- Python
- Stars
- 14
- Forks
- 37
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from hackforla/peopledepot
-
complexity: small feature: docs: PD team documentation PII: FALSE role: technical writing s: PD team size: 0.5pt
Difficulty 2/5 Half a day Newbie friendliness 65/100
hackforla/peopledepot#367 ·
-
complexity: small feature: Board/GitHub repo maintenance PII: FALSE ready for prioritization role: dev ops s: PD team size: 2pt
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
hackforla/peopledepot#351 · 2 comments ·
-
complexity: missing draft feature: table creation milestone: missing role: back end s: CTJ s: hackforla.org s: kb s: tables s: VRMS size: 2pt
Difficulty 4/5 3-5 days Newbie friendliness 48/100
hackforla/peopledepot#713 ·
-
complexity: missing draft feature: table creation milestone: missing role: back end s: CTJ s: hackforla.org s: kb s: tables s: VRMS size: 2pt
Difficulty 4/5 3-5 days Newbie friendliness 55/100
hackforla/peopledepot#712 ·
-
complexity: small feature: table creation ready for prioritization role: back end s: CTJ s: hackforla.org s: kb s: tables s: VRMS size: 2pt
hackforla/peopledepot#711 · 1 assignee ·
All issues in hackforla/peopledepot
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100