Docs: Set up Prettier for formatting Mintlify website#5020
Merged
Conversation
for some reason i had to turn --cache off
Collaborator
Author
|
Cog and prettier do not play very well with each other although I got it working properly. Notably Prettier doesn't work with multi line MDX comments: https://prettier.io/blog/2021/11/25/2.5.0#mdx so you have to one line any python code. |
abdnh
added
check:macos
Contributor
|
Windows is struggling with the long Prettier command: "the command line is too long" I tried splitting .svelte/.mdx processing into separate invocations but it's still too long. Looking into it. |
Prettier respects .gitignore, so we don't need to pass `fmt_excluded`
abdnh
approved these changes
Jun 17, 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
2 participants
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.
Linked issue (required)
closes #5018
Summary / motivation (required)
This prevents large diffs with prettier being used with the mintlify editor
A caveat of this is that the docs generated by cog now have to be prettier compatible. Also for some reason prettier has problems with the {/* */} multi-line comment format so we have to use instead.
Sadly I don't have a good way to check that the Prettier config does not differ between this PR and the editor.