Skip to content

feat: add Prettier formatting config and make targets#20

Merged
camembera merged 5 commits intomainfrom
feat/reformat
Apr 2, 2026
Merged

feat: add Prettier formatting config and make targets#20
camembera merged 5 commits intomainfrom
feat/reformat

Conversation

@camembera
Copy link
Copy Markdown
Collaborator

@camembera camembera commented Mar 17, 2026

Summary

Adds standardized Prettier configuration and make targets for consistent markdown/MDX formatting across the docs.

  • .prettierrc.json: Prettier config with printWidth 100, proseWrap preserve
  • make format: Reformat all .md/.mdx files
  • make format-check: Verify formatting compliance without changes

What Prettier will do

When make format is run (in a follow-up commit), it will:

  • Remove trailing whitespace
  • Normalize markdown table formatting
  • Ensure deterministic line endings (LF)
  • Preserve prose line breaks and code block content
  • Affect ~222 files with minor formatting changes

Test plan

  • Merge current pending PR's
  • Rebase this branch to main
  • Run make format-check to verify compliance detection works
  • Run make format on this branch to confirm changes are safe, nothing breaks
  • commit that
  • Add pre-commit "make format" & commit
  • merge to main

Add standardized formatting for markdown/MDX files:
- .prettierrc.json with printWidth 100, proseWrap preserve
- make format: reformat all .md/.mdx files
- make format-check: verify formatting compliance

Prettier removes trailing whitespace, normalizes tables, and ensures
deterministic formatting across the docs. Configuration preserves prose
line breaks and respects code block content.
@camembera camembera marked this pull request as ready for review March 19, 2026 16:21
@okjintao
Copy link
Copy Markdown
Collaborator

okjintao commented Apr 2, 2026

merge conflicts

@camembera camembera merged commit 362c28e into main Apr 2, 2026
4 checks passed
@camembera camembera deleted the feat/reformat branch April 2, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants