Setting up md/mdx file formatting using Prettier
Open
Nobody has claimed this yet.
enhancement
raccoon-gang
- Dominant language
- JavaScript
- Stars
- 140
- Forks
- 100
- Avg merge
- 1h 3m
- Merged PRs (30d)
- 30
Description
We do not have any formatting rules for md/mdx code example files displayed to users on the Paragon documentation page. It would be interesting to add a Prettier configuration (possibly a pre-commit hook in Husky) for correct code formatting.
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.
Research direction
No files or tests are named. Start by locating the Paragon documentation files containing the displayed md/mdx code examples and inspect the repository's package configuration for existing formatting or Husky setup. Done means the intended formatting rules are defined and applied consistently, with any chosen hook documented or verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100