-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Lint / prettify MDX (including code blocks) #6914
base: version-4
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for apollo-server-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 562e82e:
|
Comments are unfortunately the only thing blocking this PR. The parser breaks on HTML-style comments. JSX-style comments are acceptable by the parser, but turn up in the final HTML. So, we either:
cc @trevorblades, any insight? |
Removing myself from this old draft PR to stop the daily pings (I do think this is a good idea though if @trevorblades can help us with the comments). |
Yeah, I think this one is worth leaving open, it's just blocked by apollographql/docs#249 which DX has said they intend to do eventually. A lot of the conflicts should resolve trivially since the file updates are all done by tooling. |
Paired with @trevorblades to update our eslint and prettier config to prettify code blocks.
Aside from noise, I think this change is fairly uncontroversial and @rkoron007 has expressed that she would find the DX offered here to be a major improvement on what she currently does for code block formatting.
TODO: