From 4f383397827b75aadfc595521afc33f567c167cf Mon Sep 17 00:00:00 2001 From: Pavel Timofeev Date: Tue, 16 Jun 2020 12:46:24 -0400 Subject: [PATCH 1/6] Rename Google webmaster tools to Google Search Console and fix a few small issues (#403) Merge pull request 403 --- docs/advanced-usage.md | 8 ++++---- docs/usage.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md index 985c494..a0d0a57 100644 --- a/docs/advanced-usage.md +++ b/docs/advanced-usage.md @@ -98,7 +98,7 @@ image: ### Setting a default image -You can define a default image using [Front Matter default](https://jekyllrb.com/docs/configuration/#front-matter-defaults), to provide a default Twitter Card or OGP image to all of your posts and pages. +You can define a default image using [Front Matter defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/), to provide a default Twitter Card or OGP image to all of your posts and pages. Here is a very basic example, that you are encouraged to adapt to your needs: @@ -112,11 +112,11 @@ defaults: ### SmartyPants Titles -Titles will be processed using [Jekyll's `smartify` filter](https://jekyllrb.com/docs/templates/). This will use SmartyPants to translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a page title. +Titles will be processed using [Jekyll's `smartify` filter](https://jekyllrb.com/docs/liquid/filters/). This will use SmartyPants to translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a page title. ### Setting customized Canonical URL -You can set custom Canonical URL for a page by specifying canonical_url option in page front-matter. +You can set custom Canonical URL for a page by specifying canonical_url option in page front matter. E.g., you have the following in the page's front matter: ```yml layout: post @@ -130,7 +130,7 @@ Which will generate canonical_url with specified link in canonical_url. ``` If no canonical_url option was specified, then uses page url for generating canonical_url. -E.g., you have not specified canonical_url in front-matter: +E.g., you have not specified canonical_url in front matter: ```yml layout: post title: Title of Your Post diff --git a/docs/usage.md b/docs/usage.md index c2890fb..0a93697 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -32,8 +32,8 @@ The SEO tag will respect any of the following if included in your site's `_confi admins: 1234 ``` -* `logo` - URL to a site-wide logo (e.g., `/assets/your-company-logo.png`) - If you would like the "publisher" property to be present, you must add this field to your site's configuration, during the validation of the structured data by Google web master tools, if the `logo` field is not validated, you will find errors inherent to the publisher in the [structured datas test](https://search.google.com/structured-data/testing-tool/u/0/) -* `social` - For [specifying social profiles](https://developers.google.com/structured-data/customize/social-profiles). The following properties are available: +* `logo` - URL to a site-wide logo (e.g., `/assets/your-company-logo.png`) - If you would like the "publisher" property to be present, you must add this field to your site's configuration, during the validation of the structured data by Google Search Console, if the `logo` field is not validated, you will find errors inherent to the publisher in the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/u/0/) +* `social` - For [specifying social profiles](https://developers.google.com/search/docs/guides/enhance-site#add-your-sites-name-logo-and-social-links). The following properties are available: * `name` - If the user or organization name differs from the site's name * `links` - An array of links to social media profiles. @@ -48,7 +48,7 @@ The SEO tag will respect any of the following if included in your site's `_confi - https://keybase.io/benbalter ``` -* `google_site_verification` for verifying ownership via Google webmaster tools +* `google_site_verification` for verifying ownership via Google Search Console * Alternatively, verify ownership with several services at once using the following format: ```yml From fa6ca2891cb22844fd126fc011ede0ff012ce9e4 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Tue, 16 Jun 2020 12:46:26 -0400 Subject: [PATCH 2/6] Update history to reflect merge of #403 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 5be1d6c..0227cf9 100644 --- a/History.markdown +++ b/History.markdown @@ -6,6 +6,7 @@ * use example.com for example URL (#351) * remove Google+ from example snippet (#358) * HTTPS link to https://ogp.me/ (#359) + * Rename Google webmaster tools to Google Search Console (#403) ### Minor Enhancements From 12c2c8eb64063701b1fae8fe57c1bb5ec7e4c3b5 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sun, 28 Jun 2020 20:12:57 +0530 Subject: [PATCH 3/6] Improve documentation on plugin usage (#399) Merge pull request 399 --- docs/usage.md | 48 +++++++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 0a93697..7437c30 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,23 +1,29 @@ ## Usage -The SEO tag will respect any of the following if included in your site's `_config.yml` (and simply not include them if they're not defined): +The SEO tag will respect any of the following if included in your site's `_config.yml` (and simply not include them if +they're not defined): -* `title` - Your site's title (e.g., Ben's awesome site, The GitHub Blog, etc.), used as part of the title tag like 'page.title | title'. -* `tagline` - A short description (e.g., A blog dedicated to reviewing cat gifs), used as part of the title tag of the home page like 'title | tagline'. -* `description` - A longer description used for the description meta tag. Also used as fallback for pages that don't provide their own `description` and as part of the home page title tag if `tagline` is not defined. +* `title` - Your site's title (e.g., *Ben's Awesome Site*, *The GitHub Blog*, etc.), used as part of the title tag like +`Home | Ben's Awesome Site`. +* `tagline` - A short description (e.g., *A blog dedicated to reviewing cat gifs*), used as part of the title tag like +`Ben's Awesome Site | A blog dedicated to reviewing cat gifs` instead of `Ben's Awesome Site | Long description about a +blog dedicated to reviewing cat gifs` that would be used when `page.title` is not defined. +* `description` - A longer description used for the description meta tag. Also used as fallback for pages that don't +provide their own `description`, and also as part of the page's title tag if neither `page.title` nor `site.tagline` +has been defined. * `url` - The full URL to your site. Note: `site.github.url` will be used by default. * `author` - global author information (see [Advanced usage](advanced-usage.md#author-information)) - * `twitter` - The following properties are available: * `twitter:card` - The site's default card type - * `twitter:username` - The site's Twitter handle. You'll want to describe it like so: + * `twitter:username` - The site's Twitter handle. + + You'll want to describe them like so: ```yml twitter: username: benbalter card: summary ``` - * `facebook` - The following properties are available: * `facebook:app_id` - a Facebook app ID for Facebook insights * `facebook:publisher` - a Facebook page URL or ID of the publishing entity @@ -31,9 +37,12 @@ The SEO tag will respect any of the following if included in your site's `_confi publisher: 1234 admins: 1234 ``` - -* `logo` - URL to a site-wide logo (e.g., `/assets/your-company-logo.png`) - If you would like the "publisher" property to be present, you must add this field to your site's configuration, during the validation of the structured data by Google Search Console, if the `logo` field is not validated, you will find errors inherent to the publisher in the [Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/u/0/) -* `social` - For [specifying social profiles](https://developers.google.com/search/docs/guides/enhance-site#add-your-sites-name-logo-and-social-links). The following properties are available: +* `logo` - URL to a site-wide logo (e.g., `/assets/your-company-logo.png`) - If you would like the "publisher" property +to be present, you must add this field to your site's configuration, during the validation of the structured data by +Google Search Console, if the `logo` field is not validated, you will find errors inherent to the publisher in the +[Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/u/0/) +* `social` - For [specifying social profiles](https://developers.google.com/search/docs/guides/enhance-site#add-your-sites-name-logo-and-social-links). +The following properties are available: * `name` - If the user or organization name differs from the site's name * `links` - An array of links to social media profiles. @@ -47,19 +56,16 @@ The SEO tag will respect any of the following if included in your site's `_confi - https://github.com/benbalter - https://keybase.io/benbalter ``` - * `google_site_verification` for verifying ownership via Google Search Console * Alternatively, verify ownership with several services at once using the following format: - -```yml -webmaster_verifications: - google: 1234 - bing: 1234 - alexa: 1234 - yandex: 1234 - baidu: 1234 -``` - + ```yml + webmaster_verifications: + google: 1234 + bing: 1234 + alexa: 1234 + yandex: 1234 + baidu: 1234 + ``` * `lang` - The locale these tags are marked up in. Of the format `language_TERRITORY`. Default is `en_US`. The SEO tag will respect the following YAML front matter if included in a post, page, or document: From 8dc3a01b39e8f7b5922552ab3903bc344edd8029 Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Sun, 28 Jun 2020 10:43:00 -0400 Subject: [PATCH 4/6] Update history to reflect merge of #399 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 0227cf9..71dc52d 100644 --- a/History.markdown +++ b/History.markdown @@ -7,6 +7,7 @@ * remove Google+ from example snippet (#358) * HTTPS link to https://ogp.me/ (#359) * Rename Google webmaster tools to Google Search Console (#403) + * Improve documentation on plugin usage (#399) ### Minor Enhancements From 0b5f02ab6cbebe541cb41fe6cc1096c5312b9611 Mon Sep 17 00:00:00 2001 From: Joe Masilotti Date: Fri, 24 Jul 2020 14:34:17 -0400 Subject: [PATCH 5/6] Structured Data Testing Tool is deprecated (#409) Merge pull request 409 --- docs/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage.md b/docs/usage.md index 7437c30..78fcf07 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -40,7 +40,7 @@ has been defined. * `logo` - URL to a site-wide logo (e.g., `/assets/your-company-logo.png`) - If you would like the "publisher" property to be present, you must add this field to your site's configuration, during the validation of the structured data by Google Search Console, if the `logo` field is not validated, you will find errors inherent to the publisher in the -[Structured Data Testing Tool](https://search.google.com/structured-data/testing-tool/u/0/) +[Rich Results Testing Tool](https://search.google.com/test/rich-results) * `social` - For [specifying social profiles](https://developers.google.com/search/docs/guides/enhance-site#add-your-sites-name-logo-and-social-links). The following properties are available: * `name` - If the user or organization name differs from the site's name From 933b914ab27601ca29615489f0343c4417bb146a Mon Sep 17 00:00:00 2001 From: jekyllbot Date: Fri, 24 Jul 2020 14:34:18 -0400 Subject: [PATCH 6/6] Update history to reflect merge of #409 [ci skip] --- History.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/History.markdown b/History.markdown index 71dc52d..fdb8d0b 100644 --- a/History.markdown +++ b/History.markdown @@ -8,6 +8,7 @@ * HTTPS link to https://ogp.me/ (#359) * Rename Google webmaster tools to Google Search Console (#403) * Improve documentation on plugin usage (#399) + * Structured Data Testing Tool is deprecated (#409) ### Minor Enhancements