search

jekyll / jekyll-seo-tag

A Jekyll plugin to add metadata tags for search engines and social networks to better index and display your site's content.
https://jekyll.github.io/jekyll-seo-tag
MIT License
1.66k stars 294 forks source link

Documentation improvements #495

Open y377 opened 1 year ago

y377 commented 1 year ago

Following the official document example, I realized that I need to improve it a bit, I've been following the steps on the official website since I got in touch with jekyll 2 years ago, so I got into the habit of doing it until I inadvertently found a problem: When the jekyll-seo-tag plugin is enabled, the plugin also generates a <title>{{ page.title }} - {{ site.title }}</title> by default, which leads to duplicate titles, and I'd like to improve the docs to remind future generations!

template.html：

<!-- Begin Jekyll SEO tag v{{ seo_tag.version }} -->
{% if seo_tag.title? %}
<title>{{ seo_tag.title }}</title>
{% endif %}

head.html：

<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<title>{{ page.title }} - {{ site.title }}</title>
.......

My English is not good, and I look forward to the improved reminder as follows:

If you enable jekyll-seo-tag, make sure there is no <title> tag in your head.html or default.html

jekyllbot commented 1 year ago

This issue has been automatically marked as stale because it has not been commented on for at least two months.

The resources of the Jekyll team are limited, and so we are asking for your help.

If this is a bug and you can still reproduce this error on the master/main branch, please reply with all of the information you have about it in order to keep the issue open.

If this is a feature request, please consider whether it can be accomplished in another way. If it cannot, please elaborate on why it is core to this project and why you feel more than 80% of users would find this beneficial.

This issue will automatically be closed in two months if no further activity occurs. Thank you for all your contributions.