Skip to content

Commit fa45871

Browse files
joshbucheajoshbuchea
authored
Merge branch 'master' into patch-1
2 parents ce09b4c + cd5fbcf commit fa45871

2 files changed

Lines changed: 84 additions & 49 deletions

File tree

‎.github/workflows/sync-readme.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Sync README to gh-pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- README.md
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
sync:
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout master
20+
uses: actions/checkout@v4
21+
with:
22+
ref: master
23+
fetch-depth: 0
24+
25+
- name: Save README from master
26+
run: cp README.md /tmp/README.md
27+
28+
- name: Checkout gh-pages
29+
run: |
30+
git fetch origin gh-pages
31+
git checkout gh-pages
32+
33+
- name: Replace README
34+
run: |
35+
cp /tmp/README.md README.md
36+
37+
- name: Commit if changed
38+
run: |
39+
git config user.name "github-actions"
40+
git config user.email "github-actions@github.com"
41+
42+
if git diff --quiet README.md; then
43+
echo "No changes to commit"
44+
exit 0
45+
fi
46+
47+
git add README.md
48+
git commit -m "Sync README from master"
49+
git push origin gh-pages

‎README.md‎

Lines changed: 35 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ Below are the essential elements for any web document (websites/apps):
6464

6565
`initial-scale=1` - the initial zoom, 1 means no zoom
6666

67-
**[⬆ back to top](#table-of-contents)**
68-
6967
## Elements
7068

7169
Valid `<head>` elements include `meta`, `link`, `title`, `style`, `script`, `noscript`, and `base`.
@@ -104,8 +102,6 @@ These elements provide information for how a document should be perceived, and r
104102
</noscript>
105103
```
106104

107-
**[⬆ back to top](#table-of-contents)**
108-
109105
## Meta
110106

111107
```html
@@ -119,7 +115,7 @@ These elements provide information for how a document should be perceived, and r
119115

120116
<!--
121117
Allows control over where resources are loaded from.
122-
Place as early in the <head> as possible, as the tag
118+
Place as early in the <head> as possible, as the tag
123119
only applies to resources that are declared after it.
124120
-->
125121
<meta http-equiv="Content-Security-Policy" content="default-src 'self'">
@@ -188,8 +184,6 @@ These elements provide information for how a document should be perceived, and r
188184
- 📖 [ICBM on Wikipedia](https://en.wikipedia.org/wiki/ICBM_address#Modern_use)
189185
- 📖 [Geotagging on Wikipedia](https://en.wikipedia.org/wiki/Geotagging#HTML_pages)
190186

191-
**[⬆ back to top](#table-of-contents)**
192-
193187
## Link
194188

195189
```html
@@ -214,7 +208,9 @@ These elements provide information for how a document should be perceived, and r
214208
<!-- Gives a reference to a location in your document that may be in another language -->
215209
<link rel="alternate" href="https://es.example.com/" hreflang="es">
216210

217-
<!-- Provides information about an author or another person -->
211+
<!-- Provides information about an author or another person
212+
Used for RelMeAuth, a distributed form of identity verification.
213+
See https://microformats.org/wiki/RelMeAuth to learn more -->
218214
<link rel="me" href="https://google.com/profiles/thenextweb" type="text/html">
219215
<link rel="me" href="mailto:name@example.com">
220216
<link rel="me" href="sms:+15035550125">
@@ -228,9 +224,7 @@ These elements provide information for how a document should be perceived, and r
228224
<!-- Provides a self reference - useful when the document has multiple possible references -->
229225
<link rel="self" type="application/atom+xml" href="https://example.com/atom.xml">
230226

231-
<!-- The first, last, previous, and next documents in a series of documents, respectively -->
232-
<link rel="first" href="https://example.com/article/">
233-
<link rel="last" href="https://example.com/article/?page=42">
227+
<!-- The previous, and next documents in a series of documents, respectively -->
234228
<link rel="prev" href="https://example.com/article/?page=1">
235229
<link rel="next" href="https://example.com/article/?page=3">
236230

@@ -240,12 +234,20 @@ These elements provide information for how a document should be perceived, and r
240234
<!-- Forms an automated comment when another WordPress blog links to your WordPress blog or post -->
241235
<link rel="pingback" href="https://example.com/xmlrpc.php">
242236

243-
<!-- Notifies a URL when you link to it on your document -->
237+
<!-- Notifies a URL when you link to it on your document
238+
More information at https://webmention.net -->
244239
<link rel="webmention" href="https://example.com/webmention">
245240

246-
<!-- Enables posting to your own domain using a Micropub client -->
241+
<!-- Enables posting to your own domain using a Micropub client
242+
More information at https://indieweb.org/Micropub -->
247243
<link rel="micropub" href="https://example.com/micropub">
248244

245+
<!-- Enables you to use your site with IndieAuth, an identity solution that
246+
lets you authenticate with your domain name.
247+
Read more at https://indieauth.net. -->
248+
<link rel="token_endpoint" href="https://example.com/token">
249+
<link rel="authorization_endpoint" href="https://example.com/auth">
250+
249251
<!-- Open Search -->
250252
<link rel="search" href="/open-search.xml" type="application/opensearchdescription+xml" title="Search Title">
251253

@@ -264,8 +266,6 @@ These elements provide information for how a document should be perceived, and r
264266

265267
- 📖 [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml)
266268

267-
**[⬆ back to top](#table-of-contents)**
268-
269269
## Icons
270270

271271
```html
@@ -287,12 +287,11 @@ These elements provide information for how a document should be perceived, and r
287287
- 📖 [Favicon Cheat Sheet](https://github.com/audreyr/favicon-cheat-sheet)
288288
- 📖 [Icons & Browser Colors](https://developers.google.com/web/fundamentals/design-and-ux/browser-customization/)
289289

290-
**[⬆ back to top](#table-of-contents)**
291-
292290
## Social
293291

294292
### Facebook Open Graph
295-
> Most content is shared to Facebook as a URL, so it's important that you mark up your website with Open Graph tags to take control over how your content appears on Facebook. [More about Facebook Open Graph Markup](https://developers.facebook.com/docs/sharing/webmasters#markup)
293+
294+
> Most content is shared to Facebook as a URL, so it's important that you mark up your website with Open Graph tags to take control over how your content appears on Facebook. [More about Facebook Open Graph Markup](https://developers.facebook.com/docs/sharing/webmasters#markup)
296295
297296
```html
298297
<meta property="fb:app_id" content="123456789">
@@ -311,6 +310,7 @@ These elements provide information for how a document should be perceived, and r
311310
- 🛠 Test your page with the [Facebook Sharing Debugger](https://developers.facebook.com/tools/debug/)
312311

313312
### Twitter Card
313+
314314
> With Twitter Cards, you can attach rich photos, videos and media experiences to Tweets, helping to drive traffic to your website. [More about Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards)
315315
316316
```html
@@ -328,7 +328,9 @@ These elements provide information for how a document should be perceived, and r
328328
- 🛠 Test your page with the [Twitter Card Validator](https://cards-dev.twitter.com/validator)
329329

330330
### Twitter Privacy
331+
331332
If you embed tweets in your website, Twitter can use information from your site to tailor content and suggestions to Twitter users. [More about Twitter privacy options](https://dev.twitter.com/web/overview/privacy#what-privacy-options-do-website-publishers-have).
333+
332334
```html
333335
<!-- disallow Twitter from using your site's info for personalization purposes -->
334336
<meta name="twitter:dnt" content="on">
@@ -397,9 +399,8 @@ Users share web pages to qq wechat will have a formatted message
397399
<meta itemprop="image" content="http://imgcache.qq.com/qqshow/ac/v4/global/logo.png">
398400
<meta name="description" itemprop="description" content="share content">
399401
```
400-
- 📖 [Code Format Docs](http://open.mobile.qq.com/api/mqq/index#api:setShareInfo)
401402

402-
**[⬆ back to top](#table-of-contents)**
403+
- 📖 [Code Format Docs](http://open.mobile.qq.com/api/mqq/index#api:setShareInfo)
403404

404405
### Fediverse
405406

@@ -409,8 +410,6 @@ Some Fediverse software such as Mastodon allow you to put your Fediverse handle
409410
<meta name="fediverse:creator" content="@handle@example.org">
410411
```
411412

412-
**[⬆ back to top](#table-of-contents)**
413-
414413
## Browsers / Platforms
415414

416415
### Apple iOS
@@ -498,8 +497,6 @@ Minimum required xml markup for `browserconfig.xml`:
498497

499498
- 📖 [Browser configuration schema reference](https://msdn.microsoft.com/en-us/library/dn320426.aspx)
500499

501-
**[⬆ back to top](#table-of-contents)**
502-
503500
## Browsers (Chinese)
504501

505502
### 360 Browser
@@ -549,8 +546,6 @@ Minimum required xml markup for `browserconfig.xml`:
549546

550547
- 📖 [UC Browser Docs](https://www.uc.cn/download/UCBrowser_U3_API.doc)
551548

552-
**[⬆ back to top](#table-of-contents)**
553-
554549
## App Links
555550

556551
```html
@@ -570,45 +565,37 @@ Minimum required xml markup for `browserconfig.xml`:
570565

571566
- 📖 [App Links](https://developers.facebook.com/docs/applinks)
572567

573-
**[⬆ back to top](#table-of-contents)**
574-
575568
## Other Resources
576569

577570
- 📖 [HTML5 Boilerplate Docs: The HTML](https://github.com/h5bp/html5-boilerplate/blob/master/dist/doc/html.md)
578571
- 📖 [HTML5 Boilerplate Docs: Extend and customize](https://github.com/h5bp/html5-boilerplate/blob/master/dist/doc/extend.md)
579572

580-
**[⬆ back to top](#table-of-contents)**
581-
582573
## Related Projects
583574

584575
- [Atom HTML Head Snippets](https://github.com/joshbuchea/atom-html-head-snippets) - Atom package for `HEAD` snippets
585576
- [Sublime Text HTML Head Snippets](https://github.com/marcobiedermann/sublime-head-snippets) - Sublime Text package for `HEAD` snippets
586577
- [head-it](https://github.com/hemanth/head-it) - CLI interface for `HEAD` snippets
587578
- [vue-head](https://github.com/ktquez/vue-head) - Manipulating the meta information of the `HEAD` tag for Vue.js
588579

589-
**[⬆ back to top](#table-of-contents)**
590-
591580
## Other Formats
592581

593582
- 📄 [PDF](https://gitprint.com/joshbuchea/HEAD/blob/master/README.md)
594583

595-
**[⬆ back to top](#table-of-contents)**
596-
597584
## 🌐 Translations
598585

599-
- 🇮🇩 [Bahasa](https://github.com/rijdz/HEAD)
600-
- 🇧🇷 [Brazilian Portuguese](https://github.com/Webschool-io/HEAD)
601-
- 🇨🇳 [Chinese (Simplified)](https://github.com/Amery2010/HEAD)
602-
- 🇩🇪 [German](https://github.com/Shidigital/HEAD)
603-
- 🇮🇹 [Italian](https://github.com/Fakkio/HEAD)
604-
- 🇯🇵 [Japanese](https://coliss.com/articles/build-websites/operation/work/collection-of-html-head-elements.html)
605-
- 🇰🇷 [Korean](https://github.com/Lutece/HEAD)
606-
- 🇲🇾🇧🇳🇸🇬 [Malay](https://github.com/shoen1x/HEAD)
607-
- 🇷🇺 [Russian/Русский](https://github.com/Konfuze/HEAD)
608-
- 🇪🇸 [Spanish](https://github.com/alvaroadlf/HEAD)
609-
- 🇹🇷 [Turkish/Türkçe](https://github.com/mkg0/HEAD)
610-
611-
**[⬆ back to top](#table-of-contents)**
586+
- [Bahasa](https://github.com/rijdz/HEAD)
587+
- [Bengali](https://github.com/AveyBD/HEAD)
588+
- [Brazilian Portuguese](https://github.com/Webschool-io/HEAD)
589+
- [Chinese (Simplified)](https://github.com/Amery2010/HEAD)
590+
- [German](https://github.com/Shidigital/HEAD)
591+
- [Italian](https://github.com/Fakkio/HEAD)
592+
- [Japanese](https://coliss.com/articles/build-websites/operation/work/collection-of-html-head-elements.html)
593+
- [Korean](https://github.com/Lutece/HEAD)
594+
- [Malay](https://github.com/shoen1x/HEAD)
595+
- [Russian/Русский](https://github.com/Konfuze/HEAD)
596+
- [Spanish](https://github.com/alvaroadlf/HEAD)
597+
- [Turkish/Türkçe](https://github.com/mkg0/HEAD)
598+
- [Ukrainian](https://github.com/Shramkoweb/HEAD)
612599

613600
## 🤝 Contributing
614601

@@ -625,6 +612,7 @@ This branch consists of the `README.md` file that is reflected on the [htmlhead.
625612
Please follow these steps for pull requests:
626613

627614
{:.list-style-default}
615+
628616
- Modify only one tag, or one related set of tags at a time
629617
- Use double quotes on attributes
630618
- Don't include a trailing slash in self-closing elements — the HTML5 spec says they're optional
@@ -663,5 +651,3 @@ Everything helps, thanks! 🙏
663651
## 📝 License
664652

665653
[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
666-
667-
**[⬆ back to top](#table-of-contents)**

0 commit comments

Comments
 (0)