Skip to content
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

fix(README): typos and markdown issues #305

Merged
merged 3 commits into from
Jan 4, 2023
Merged

fix(README): typos and markdown issues #305

merged 3 commits into from
Jan 4, 2023

Conversation

mstephen19
Copy link
Contributor

@mstephen19 mstephen19 commented Dec 12, 2022

I've fixed a few minor things in the README. Here is a list:

  1. Unnecessary double newlines.
  2. English error:
    "Third-party plugins and presets named startING with size-limit- are also supported"
  3. List went 1, 2, 3, 4, 6, 7, 8, 9. Bumped back 6, 7, 8, and 9. There are 8 items in the list.
  4. In markdown when displaying shell commands, the $ should only be present when the result of the command is displayed right below within the same block. If it's just the command alone, the $ should be omitted.

@mstephen19 mstephen19 changed the title fix(README) fix(README): typos and markdown issues Dec 12, 2022
@ai
Copy link
Owner

ai commented Dec 12, 2022

Looks good, but can you revert Unnecessary double newlines changes?

I use a Markdown code style when we have 2 newline before header and 1 newline after (to emulate bigger top margin).

@ai ai merged commit 90e0291 into ai:main Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants