Skip to content

Commit 854417d

Browse files
committed
sync readme from gh-pages
1 parent 5c6ef69 commit 854417d

1 file changed

Lines changed: 23 additions & 18 deletions

File tree

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 🗿 HEAD
1+
# 🤯 HEAD
22

3-
> A list of everything that \*could\* go in the `<head>` of your document
3+
> A simple guide to HTML `<head>` elements
44
55
[![Contributors](https://img.shields.io/github/contributors/joshbuchea/head.svg?style=for-the-badge)](https://github.com/joshbuchea/HEAD/graphs/contributors)
66
[![CC0](https://img.shields.io/badge/license-CC0-green.svg?style=for-the-badge)](https://creativecommons.org/publicdomain/zero/1.0/)
@@ -56,14 +56,13 @@ Below are the essential elements for any web document (websites/apps):
5656
<title>Page Title</title>
5757
```
5858

59-
**meta charset** - defines the encoding of the website, utf-8 is the standard
59+
`meta charset` - defines the encoding of the website, `utf-8` is the standard
6060

61-
**meta name="viewport"** - viewport settings related to mobile responsiveness
61+
`meta name="viewport"` - viewport settings related to mobile responsiveness
6262

63-
**width=device-width** means that it will use the physical width of the device (instead of zooming out) which is good with mobile friendly pages
64-
65-
**initial-scale=1** is the initial zoom, 1 means no zoom
63+
`width=device-width` - use the physical width of the device (great for mobile!)
6664

65+
`initial-scale=1` - the initial zoom, 1 means no zoom
6766

6867
**[⬆ back to top](#table-of-contents)**
6968

@@ -610,39 +609,45 @@ The **HEAD** repository consists of two branches:
610609

611610
#### 1. `master`
612611

613-
This branch consists of the `README.md` file that is automatically reflected on the [htmlhead.dev](https://htmlhead.dev/) website. All changes to the content of the cheat sheet as such should be directed to this file.
612+
This branch consists of the `README.md` file that is reflected on the [htmlhead.dev](https://htmlhead.dev/) website. All changes to the content of the guide should be made in this file.
614613

615614
Please follow these steps for pull requests:
616615

616+
{:.list-style-default}
617617
- Modify only one tag, or one related set of tags at a time
618618
- Use double quotes on attributes
619619
- Don't include a trailing slash in self-closing elements — the HTML5 spec says they're optional
620620
- Consider including a link to documentation that supports your change
621621

622622
#### 2. `gh-pages`
623623

624-
This branch is responsible for the [htmlhead.dev](https://htmlhead.dev/) website. We use [Jekyll](https://jekyllrb.com/) to deploy the `README.md` Markdown file through [GitHub Pages](https://pages.github.com/). All website related modifications must be directed here.
624+
This branch is responsible for the [htmlhead.dev](https://htmlhead.dev/) website. We use [Jekyll](https://jekyllrb.com/) to deploy the `README.md` markdown file to [GitHub Pages](https://pages.github.com/). All website related modifications should be made in this branch.
625625

626-
You may want to go through the [Jekyll Docs](https://jekyllrb.com/docs/home/) and understand how Jekyll works before working on this branch.
626+
You may find it helpful to review the [Jekyll Docs](https://jekyllrb.com/docs/home/) and understand how Jekyll works before working in this branch.
627627

628-
### Contributors
628+
## 🌟 Contributors
629629

630-
Check out all the super awesome [contributors](https://github.com/joshbuchea/HEAD/graphs/contributors).
630+
Check out all the super awesome [contributors](https://github.com/joshbuchea/HEAD/graphs/contributors) 🤩
631631

632632
## 👤 Author
633633

634634
**Josh Buchea**
635635

636+
- GitHub: [@joshbuchea](https://github.com/joshbuchea)
636637
- Twitter: [@joshbuchea](https://twitter.com/joshbuchea)
637-
- Github: [@joshbuchea](https://github.com/joshbuchea)
638638

639-
## Show your support
639+
## 💛 Support
640+
641+
If this project was helpful for you or your organization, please considering supporting my work directly:
642+
643+
- 💛 [Sponsor me on GitHub](https://github.com/sponsors/joshbuchea)
644+
- ⭐️ [Star this project on GitHub](https://github.com/joshbuchea/HEAD)
645+
- 🐙 [Follow me on GitHub](https://github.com/joshbuchea)
646+
- 🐦 [Follow me on Twitter](https://twitter.com/joshbuchea)
640647

641-
Please ⭐️ this repository if this project helped you!
648+
Everything helps, thanks! 🙏
642649

643-
<a href="https://www.patreon.com/joshbuchea">
644-
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
645-
</a>
650+
— Josh
646651

647652
## 📝 License
648653

0 commit comments

Comments
 (0)