Add Prettier and format all Markdown docs #41
Merged
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
In order to have Prettier for formatting all the Markdown files, we need to add a package.json for npm. re #36
Add a dependency on the Prettier package so we can start using it for formatting Markdown files. Add the package-lock.json to ensure we maintain our dependency tree in source control. Also, we now need to ensure we gitignore the node_modules directory. re #36
Using NPM's scripts feature, add a couple useful commands to format the markdown files and ensure they stay formatted. re #36
Now that we have prettier installed and easy to access npm scripts, we can format all the Markdown files to the default Prettier formatting. re #36
Add clear instructions to ensure all contributions format documents with Prettier and add an initial section outlining how to setup one's workstation for making a contribution. re #36
amaltson
force-pushed
the
add-prettier-markdown-formatting
branch
from
717e82d
to
b9485b4
Compare
Configure Prettier to always wrap long lines (prose) by adding a local Prettier config file. We can further tweak Prettier if we need with this file. See: https://prettier.io/docs/en/options.html#prose-wrap
17 tasks
mcleo-d
reviewed
Nov 3, 2021
There was a problem hiding this comment.
Hey @amaltson - I believe these changes have also been picked up in #42 and #44 too.
It would be awesome to plan the PR merge order to make sure you don't pick up any accidental merge conflicts should content be altered as the other PRs are reviewed and potentially changed.
I suggest this PR is merged first to get the initial MD change into the repo. It would be awesome to get your thoughts?
|
@mcleo-d that's exactly right. The PR merge order should be:
Technically #44 can come before #42 as well. But after each merge I'll make sure to rebase the PRs. #43 is independent of all of them, so it can go any time. |
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.
This is the first in a couple of PRs to address #36. This first PR does the
following:
package.jsonto start making use of NPM to install and then usePrettier to format our Markdown documents.
workstation setup instructions.