Skip to content

run prettier over docs#796

Closed
wez wants to merge 2 commits into
masterfrom
prettydocs
Closed

run prettier over docs#796
wez wants to merge 2 commits into
masterfrom
prettydocs

Conversation

@wez

@wez wez commented Mar 28, 2020

Copy link
Copy Markdown
Contributor

The package.json defines yarn ci as a command to verify that
the docs conform to the right style, but this was failing because
there were some missing plugins referenced by the config that we
don't need in the watchman project and that were overly pedantic
(generating an error because of the use of single quotes in the
index page: single quotes are perfectly legal and much more convenient
than the escaped HTML entity).

yarn prettier is another command defined by the package.json; it
runs code formatting over the website js and md files. While I
may not agree with its styling it is automatic.

This commit applies yarn prettier to the markdown files and fixes
up the linter config so that it doesn't flag anything as bad here.

The package.json defines `yarn ci` as a command to verify that
the docs conform to the right style, but this was failing because
there were some missing plugins referenced by the config that we
don't need in the watchman project and that were overly pedantic
(generating an error because of the use of single quotes in the
index page: single quotes are perfectly legal and much more convenient
than the escaped HTML entity).

`yarn prettier` is another command defined by the package.json; it
runs code formatting over the website js and md files.  While I
may not agree with its styling it is automatic.

This commit applies `yarn prettier` to the markdown files and fixes
up the linter config so that it doesn't flag anything as bad here.
That is undesirable as we are generating the docs anyway.
https://v2.docusaurus.io/docs/deployment/

Test Plan:
built and inspected locally.  Deployed to the live site.

@facebook-github-bot facebook-github-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wez has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

@wez wez deleted the prettydocs branch March 30, 2020 22:33
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@wez merged this pull request in ea3d1fd.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants