basic markdown formatting in remark; disabled prettier md formatting#9190
Merged
basic markdown formatting in remark; disabled prettier md formatting#9190
Conversation
tjzel
reviewed
Mar 31, 2026
tshmieldev
force-pushed
the
@tshmieldev/md-formatting
branch
from
16714bd to
6264917
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR switches Markdown/MDX formatting from Prettier to Remark, adds repository-level Remark configuration/ignores, and applies the new formatting across existing docs/READMEs.
Changes:
- Added
remark-based formatting (format:md) plus repo-level.remarkrc*and.remarkignore. - Disabled Prettier for
*.md/*.mdxvia.prettierignore(and doc-site.prettierignorefiles). - Re-formatted a large set of Markdown/MDX documents to match the new Remark output.
Reviewed changes
Copilot reviewed 179 out of 186 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/react-native-worklets/README.md | Remark reformatting (links/badges escaping) |
| packages/react-native-worklets/plugin/README-dev.md | Remark reformatting (markdown text) |
| packages/react-native-worklets/Common/cpp/worklets/WorkletRuntime/RuntimeInitialization.md | Remark reformatting (escaping) |
| packages/react-native-worklets/bundleMode/patches/README.md | Remark reformatting (lists/code fences) |
| packages/react-native-reanimated/README.md | Remark reformatting (links/badges escaping) |
| package.json | Add format:md + add remark deps |
| docs/docs-worklets/README.md | Remark reformatting (task list) |
| docs/docs-worklets/docs/worklets-babel-plugin/about.md | Remark reformatting |
| docs/docs-worklets/docs/utility/isWorkletRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/utility/isWorkletFunction.mdx | Remark reformatting |
| docs/docs-worklets/docs/utility/isWorkerRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/utility/isUIRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/utility/isRNRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/utility/getRuntimeKind.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/uiRuntimeId.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/scheduleOnUI.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/scheduleOnRuntimeWithId.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/scheduleOnRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/scheduleOnRN.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnUISync.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnUIAsync.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnUI.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnRuntimeSyncWithId.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnRuntimeSync.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnRuntimeAsync.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/runOnJS.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/executeOnUIRuntimeSync.mdx | Remark reformatting |
| docs/docs-worklets/docs/threading/createWorkletRuntime.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/synchronizable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/shareable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/serializable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/makeShareableCloneRecursive.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/makeShareableCloneOnUIRecursive.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/makeShareable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/isSynchronizable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/isSerializableRef.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/createSynchronizable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/createShareable.mdx | Remark reformatting |
| docs/docs-worklets/docs/memory/createSerializable.mdx | Remark reformatting |
| docs/docs-worklets/docs/guides/troubleshooting.mdx | Remark reformatting |
| docs/docs-worklets/docs/guides/testing-with-jest.mdx | Remark reformatting |
| docs/docs-worklets/docs/guides/feature-flags.md | Remark reformatting |
| docs/docs-worklets/docs/guides/call-tables.mdx | Remark reformatting |
| docs/docs-worklets/docs/fundamentals/runtimeKinds.mdx | Remark reformatting |
| docs/docs-worklets/docs/fundamentals/getting-started.mdx | Remark reformatting |
| docs/docs-worklets/docs/bundleMode/setup.mdx | Remark reformatting |
| docs/docs-worklets/docs/bundleMode/overview.mdx | Remark reformatting |
| docs/docs-worklets/.prettierignore | Ignore *.md for doc-site formatting |
| docs/docs-reanimated/versioned_docs/version-3.x/utilities/useAnimatedGestureHandler.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/utilities/interpolateColor.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/utilities/interpolate.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/utilities/getRelativeCoords.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/utilities/clamp.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/threading/runOnUI.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/threading/runOnRuntime.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/threading/runOnJS.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/threading/createWorkletRuntime.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/shared-element-transitions/overview.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/scroll/useScrollViewOffset.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/scroll/useAnimatedScrollHandler.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/scroll/scrollTo.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/reanimated-babel-plugin/options.md | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/reanimated-babel-plugin/about.md | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/layout-animations/list-layout-animations.mdx | Remark reformatting (MDX layout) |
| docs/docs-reanimated/versioned_docs/version-3.x/layout-animations/layout-transitions.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/layout-animations/layout-animation-config.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/layout-animations/keyframe-animations.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/guides/web-support.mdx | Remark reformatting (install snippet) |
| docs/docs-reanimated/versioned_docs/version-3.x/guides/troubleshooting.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/guides/debugging-worklets.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/guides/building-for-android-on-windows.md | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/fundamentals/handling-gestures.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/fundamentals/getting-started.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/fundamentals/customizing-animation.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/device/useAnimatedKeyboard.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/device/ReducedMotionConfig.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/debugging/logger-configuration.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/debugging/accurate-call-stacks.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/core/useDerivedValue.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/core/useAnimatedRef.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/core/useAnimatedProps.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/core/createAnimatedComponent.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/core/cancelAnimation.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withTiming.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withSpring.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withSequence.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withRepeat.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withDelay.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withDecay.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/animations/withClamp.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/useHandler.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/useFrameCallback.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/useEvent.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/useComposedEventHandler.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/useAnimatedReaction.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/setNativeProps.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/measure.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/advanced/dispatchCommand.mdx | Remark reformatting |
| docs/docs-reanimated/versioned_docs/version-3.x/_shared/_unreleased_info.mdx | MDX comment syntax normalization |
| docs/docs-reanimated/docs/utilities/interpolateColor.mdx | Remark reformatting |
| docs/docs-reanimated/docs/utilities/interpolate.mdx | Remark reformatting |
| docs/docs-reanimated/docs/utilities/getRelativeCoords.mdx | Remark reformatting |
| docs/docs-reanimated/docs/utilities/DynamicColorIOS.mdx | Remark reformatting |
| docs/docs-reanimated/docs/utilities/clamp.mdx | Remark reformatting |
| docs/docs-reanimated/docs/shared-element-transitions/overview.mdx | Remark reformatting |
| docs/docs-reanimated/docs/scroll/useScrollOffset.mdx | Remark reformatting (link formatting) |
| docs/docs-reanimated/docs/scroll/useAnimatedScrollHandler.mdx | Remark reformatting |
| docs/docs-reanimated/docs/scroll/scrollTo.mdx | Remark reformatting |
| docs/docs-reanimated/docs/layout-animations/list-layout-animations.mdx | Remark reformatting (MDX layout) |
| docs/docs-reanimated/docs/layout-animations/layout-transitions.mdx | Remark reformatting |
| docs/docs-reanimated/docs/layout-animations/layout-animation-config.mdx | Remark reformatting |
| docs/docs-reanimated/docs/layout-animations/keyframe-animations.mdx | Remark reformatting |
| docs/docs-reanimated/docs/guides/troubleshooting.mdx | Remark reformatting |
| docs/docs-reanimated/docs/guides/migration-from-3.x.md | Remark reformatting |
| docs/docs-reanimated/docs/guides/feature-flags.md | Remark reformatting |
| docs/docs-reanimated/docs/guides/debugging-worklets.mdx | Remark reformatting |
| docs/docs-reanimated/docs/guides/building-for-android-on-windows.md | Remark reformatting |
| docs/docs-reanimated/docs/fundamentals/handling-gestures.mdx | Remark reformatting |
| docs/docs-reanimated/docs/fundamentals/getting-started.mdx | Remark reformatting |
| docs/docs-reanimated/docs/fundamentals/customizing-animation.mdx | Remark reformatting |
| docs/docs-reanimated/docs/device/useAnimatedKeyboard.mdx | Remark reformatting |
| docs/docs-reanimated/docs/device/ReducedMotionConfig.mdx | Remark reformatting |
| docs/docs-reanimated/docs/debugging/logger-configuration.mdx | Remark reformatting |
| docs/docs-reanimated/docs/debugging/accurate-call-stacks.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-transitions/transition-property.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-transitions/transition-duration.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-transitions/transition-delay.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-transitions/transition-behavior.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-play-state.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-name.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-iteration-count.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-fill-mode.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-duration.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-direction.mdx | Remark reformatting |
| docs/docs-reanimated/docs/css-animations/animation-delay.mdx | Remark reformatting |
| docs/docs-reanimated/docs/core/useDerivedValue.mdx | Remark reformatting |
| docs/docs-reanimated/docs/core/useAnimatedRef.mdx | Remark reformatting |
| docs/docs-reanimated/docs/core/useAnimatedProps.mdx | Remark reformatting |
| docs/docs-reanimated/docs/core/createAnimatedComponent.mdx | Remark reformatting |
| docs/docs-reanimated/docs/core/cancelAnimation.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withTiming.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withSpring.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withSequence.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withRepeat.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withDelay.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withDecay.mdx | Remark reformatting |
| docs/docs-reanimated/docs/animations/withClamp.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/useHandler.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/useFrameCallback.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/useEvent.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/useComposedEventHandler.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/useAnimatedReaction.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/setNativeProps.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/measure.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/makeMutable.mdx | Remark reformatting |
| docs/docs-reanimated/docs/advanced/dispatchCommand.mdx | Remark reformatting |
| docs/docs-reanimated/docs/_shared/_unreleased_info.mdx | MDX comment syntax normalization |
| docs/docs-reanimated/.prettierignore | Ignore *.md for doc-site formatting |
| apps/web-example/README.md | Remark reformatting |
| apps/macos-example/README.md | Remark reformatting |
| .remarkrc.mjs | New remark config for .md |
| .remarkrc.mdx.mjs | New remark config for .mdx |
| .remarkignore | Exclude build artifacts + older versioned docs from remark |
| .prettierignore | Stop Prettier from formatting md/mdx (remark is source of truth) |
| .github/ISSUE_TEMPLATE/cherry-pick-thread.md | Remark reformatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tjzel
requested changes
Apr 8, 2026
Collaborator
tjzel
left a comment
tjzel
left a comment
There was a problem hiding this comment.
Please add to the PR description a list of resulting formatting style changes and an explanation why each change is necessary.
tjzel
reviewed
Apr 8, 2026
Collaborator
|
Also, let's add a GitHub workflow (or use an existing one) that verifies if all changed markdown documents were formatted properly - see https://github.com/software-mansion/react-native-reanimated/blob/main/.github/workflows/monorepo-static-checks.yml for example reference |
tshmieldev
requested review from
kmagiera,
piaskowyk and
tomekzaw
as code owners
tjzel
requested changes
Apr 10, 2026
tshmieldev
force-pushed
the
@tshmieldev/md-formatting
branch
from
ce10a94 to
ae314db
Compare
tshmieldev
force-pushed
the
@tshmieldev/md-formatting
branch
from
421625f to
f90b4e3
Compare
tshmieldev
force-pushed
the
@tshmieldev/md-formatting
branch
from
f90b4e3 to
0528884
Compare
tjzel
reviewed
Apr 13, 2026
Collaborator
tjzel
left a comment
tjzel
left a comment
There was a problem hiding this comment.
Looks good, but let's first compare the built docs side-by-side as discussed offline to make sure nothing broke.
Co-authored-by: Tomasz Żelawski <40713406+tjzel@users.noreply.github.com>
tshmieldev
force-pushed
the
@tshmieldev/md-formatting
branch
from
bfcdfa9 to
02e2fc8
Compare
tjzel
approved these changes
Apr 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added basic markdown formatting in remark and disabled prettier md formatting
Test plan
run
yarn format:md