docs(fix): revert prettier formatting on markdown files #1612
Conversation
This file contains 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
|
Deploy preview for netlify-cms-www ready! Built with commit 32ee5a3 |
tech4him1
changed the title
|
Deploy preview for cms-demo ready! Built with commit 32ee5a3 |
tech4him1
force-pushed
the
revert-prettier-docs
branch
3 times, most recently
from
66ba987
to
b6f56ae
Compare
Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style. It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them.
talves
reviewed
Aug 14, 2018
website/content/docs/widgets/list.md
Outdated
| ``` | ||
|
|
There was a problem hiding this comment.
These blank line separators cause format errors. (needs review when build completes).
list.md looks like it might be the only one so far
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.
Summary
Prettier formatting our markdown files is causing bugs because of the differences between Gatsby's parser and Prettier's. Also, Prettier formats the inline code-blocks containing example CMS configs, but the formatting it uses doesn't really make much sense or match the suggested CMS config style.
It doesn't actually make much sense to format the docs anyway, since we use the CMS itself to edit/generate them.
Test plan
A picture of a cute animal (not mandatory but encouraged)