Skip to content

Format Markdown with Prettier and enforce in CI - #10

Open
nbarbier-265 wants to merge 2 commits into
aws-neuron:mainfrom
nbarbier-265:chore/prettier-markdown
Open

Format Markdown with Prettier and enforce in CI#10
nbarbier-265 wants to merge 2 commits into
aws-neuron:mainfrom
nbarbier-265:chore/prettier-markdown

Conversation

@nbarbier-265

Copy link
Copy Markdown

Summary

Many of the Markdown tables in this repo have ragged, misaligned pipes, which makes them hard to read and edit. This PR:

  • Adds a minimal .prettierrc (proseWrap: preserve, so prose is left untouched)
  • Adds a GitHub Actions workflow that runs prettier --check "**/*.md" on pushes to main and on pull requests, with actions pinned by commit SHA and the Prettier version pinned to 3.8.3
  • Applies prettier --write "**/*.md" across the repo (214 of 218 files touched)

The formatting commit is purely mechanical — it normalizes table alignment and Markdown spacing with no content changes. Reviewing the two commits separately may be easiest: the first adds the config/CI, the second is the formatter output.

Test plan

  • bunx prettier@3.8.3 --check "**/*.md" passes locally on this branch
  • The new workflow runs the identical check in CI, so future PRs with unformatted Markdown will fail the check

🤖 Generated with Claude Code

https://claude.ai/code/session_01EGhwNKx7XdB1HGYULTzgoD

Mechanical output of prettier --write on all .md files (prettier 3.8.3).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Claude-Session: https://claude.ai/code/session_01EGhwNKx7XdB1HGYULTzgoD
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.

1 participant