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

Update readme with emoji #1207

Merged
merged 5 commits into from
Apr 9, 2018
Merged

Update readme with emoji #1207

merged 5 commits into from
Apr 9, 2018

Conversation

styfle
Copy link
Member

@styfle styfle commented Apr 5, 2018

Description

🌶 Spice up the readme with emoji and logo

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

@styfle styfle requested review from UziTech, joshbruce and davisjam April 5, 2018 21:18
@styfle
Copy link
Member Author

styfle commented Apr 5, 2018

Demo of this change: https://github.com/styfle/marked/blob/readme-emoji/README.md

Should I update the homepage too? https://marked.js.org/#/README.md

@UziTech
Copy link
Member

UziTech commented Apr 5, 2018

looks like the line under the Marked header passes through the logo

image

@styfle
Copy link
Member Author

styfle commented Apr 6, 2018

@UziTech Interesting. How does it look now?

@styfle styfle added the category: docs Documentation changes label Apr 6, 2018
README.md Outdated
- ⚡ built for speed
- ⬇️ low-level markdown compiler for parsing without caching or blocking for long periods of time
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
- 🌐 works in the browser, on the server, or on the command line interface (CLI)
Copy link
Member

Choose a reason for hiding this comment

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

"...or through a command line interface" ??

Copy link
Member Author

Choose a reason for hiding this comment

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

Here’s how I think:

  • You run code in the browser
  • You run code on the server
  • You run code on the command line
  • You run code from the command line
  • You run code through a command line

I think “from” might be best here.
@UziTech Thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

"from" sound best to me

Copy link
Member Author

Choose a reason for hiding this comment

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

✅ Done

README.md Outdated
- ⚡ built for speed
- ⬇️ low-level markdown compiler for parsing without caching or blocking for long periods of time
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
- 🌐 works in the browser, on the server, or from the command line interface (CLI)
Copy link
Member

Choose a reason for hiding this comment

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

Should "the" be changed to "a"

  • 🌐 works in a browser, on a server, or from a command line interface (CLI)

Copy link
Member Author

Choose a reason for hiding this comment

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

✅ Sure thing

@styfle
Copy link
Member Author

styfle commented Apr 9, 2018

/cc @joshbruce

Copy link
Member

@joshbruce joshbruce left a comment

Choose a reason for hiding this comment

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

My designer brain wants to modify the first two for consistency but not a deal-breaker as I'm not sure what's available from the default set. :)

zhenalexfan pushed a commit to zhenalexfan/MarkdownHan that referenced this pull request Nov 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants