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.

Sign up for GitHub

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

Jump to bottom

Improve documentation on plugin usage #399

Merged
merged 3 commits into from
Jun 28, 2020
Merged

Improve documentation on plugin usage #399

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f1df93e
Improve documentation on plugin usage
ashmaroli Jun 7, 2020
6d2ffd7
Apply suggestions from code review
ashmaroli Jun 28, 2020
5b258a0
Merge branch 'master' into improve-usage-docs
ashmaroli Jun 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 27 additions & 21 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

Expand All @@ -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:
Expand Down