feat(permalink): add pretty_urls option to remove index.html from url by curbengh · Pull Request #3691 · hexojs/hexo

curbengh · 2019-08-28T05:05:58Z

What does it do?

Currently permalink variable of post, page, tag, category may end with "index.html". This PR adds canonical_url option to remove that. canonical_url defaults to false to avoid breaking change.

This is useful for SEO when web server (including hexo server) rewrite "index.html", so the url without it is the canonical version.

This way, plugins that use post.permalink don't need to remove it. Tested with hexo-generator-sitemap.
Related:

Note this PR doesn't cover this.url(#3661).

New option:

pretty_urls:
  trailing_index: true

How to test

git clone -b canonical https://github.com/curbengh/hexo.git
cd hexo
npm install
npm test

Pull request tasks

Add test cases for the changes.
Passed the CI test.

Fixes #1306 cc @sapegin @pyyzcwg2833

coveralls · 2019-08-28T05:08:06Z

Coverage increased (+0.08%) to 97.23% when pulling 8c0ca00 on curbengh:canonical into 01eebda on hexojs:master.

SukkaW · 2019-08-28T08:03:38Z

canonical_url is not accurate enough. IMHO, url_strip is more appropriate.

curbengh · 2019-08-28T10:36:26Z

I opt for canonical_url as similar function (named canonical) can be found in hexo-theme-next.

SukkaW · 2019-08-28T11:56:38Z

@curbengh

The canonical config in NexT theme is used to control whether add link[canonical] tag to <head>.
Since this PR introduced a feature to remove index.html in url, IMHO the option should be named something strip.

yoshinorin · 2019-08-28T12:00:50Z

canonical_url is not accurate enough.

+1

Maybe we can find more better naming. url_ending, url_trailing etc... also url_strip

And I would like to implement a trailing slash option.

_config.yml

# following namings are an example.
url_trailing:
  include_html: true      # https://example.com/foo/index.html
  slash: true             # This option will be enabled if include_html is false. https://example.com/foo/

If we implement this idea user can select which they use from three patterns url.

https://example.com/foo/index.html
https://example.com/foo
https://example.com/foo/

But, I'm worry followings if implement trailing slash option.

Increase source code complexity
User may confusing

How do you think?

curbengh · 2019-08-29T03:05:15Z

The canonical config in NexT theme is used to control whether add link[canonical] tag to <head>.

I'm aware of that, what I meant is the end goal is the same, which is to tell the links to search engines or readers that the links without "index.html" is the canonical version.

I dismissed the idea url_strip: false/true because it doesn't explain the goal and is more confusing.

But I do like the suggestion by @yoshinorin

trailing_url:
  include_html: true
  trailing_slash: true

And I would like to implement a trailing slash option.

Sounds good.

curbengh · 2019-08-30T09:43:18Z

I changed the option to:

trailing_url:
  trailing_index: true

SukkaW · 2019-08-30T12:47:50Z

LGTM!

curbengh · 2019-08-30T13:24:18Z

Thanks. Anyway, this can defer to v4.1.

curbengh · 2019-09-01T00:39:41Z

just stumbled upon Cryogen which uses option,

clean-urls: 'trailing-slash'

yoshinorin · 2019-09-14T09:19:11Z

@curbengh

Sorry so late reply.
IMHO trailing_url.trailing_index is redundant naming.

just stumbled upon Cryogen which uses option,

Is this mean to specify the option by a string? If yes, it seems a better way.

curbengh · 2019-09-14T10:16:19Z

Specify by string means only one option though. handling multiple options in an array can be awkward.

What about trailing_url.html?

SukkaW · 2019-09-14T15:22:53Z

@curbengh @yoshinorin

From Netlify dashboard there is an option: Assets Optimization - Pretty URLs:

We might name the config like:

{
  "pretty_urls": {
    "trailing_index": false,
    "trailing_html": false,
    "trailing_slash": true
  }
}

yoshinorin · 2019-09-16T13:28:05Z

@SukkaW It seems better idea :)
@curbengh If you have no objections would you please update like Netlify options?

curbengh · 2019-09-17T04:51:08Z

Done 👍

yoshinorin

LGTM 🚀

SukkaW · 2019-09-18T13:12:18Z

Also, should we bring up trailing_html (When disabled, /about.html => /about) and trailing_slash (When disabled, /about/ => /about) options in 4.0.0?

yoshinorin · 2019-09-18T14:46:18Z

Yes, if possible.
I'm going to implement it but now I'm a bit busy... if someone creat PR I will review it.

SukkaW · 2019-09-18T14:56:35Z

@yoshinorin I might implement it after #3708 & #3710 merged.

- pretty_urls.trailing_index: hexojs/hexo#3691 - external_link.enable: hexojs/hexo#3675 - meta_generator: hexojs/hexo#3653 - use_date_for_updated: hexojs/hexo#3235

- hexojs/hexo#3691

- pretty_urls.trailing_index: hexojs/hexo#3691 - external_link.enable: hexojs/hexo#3675 - meta_generator: hexojs/hexo#3653 - use_date_for_updated: hexojs/hexo#3235

curbengh added 3 commits August 26, 2019 16:44

feat(permalink): add canonical_url option to remove index.html from url

b03094d

test(permalink): url should not ends with index.html when canonical_url

5661765

feat(canonical_url): default to false

1e9c405

curbengh mentioned this pull request Aug 28, 2019

fix(open_graph): remove index.html from url #3661

Merged

2 tasks

stevenjoezhang mentioned this pull request Aug 28, 2019

Causing SEO confusion by setting canonical to true theme-next/hexo-theme-next#866

Closed

11 tasks

curbengh mentioned this pull request Aug 30, 2019

如果md文件名中含有&等特殊字符，使用chrome浏览器等读取sitemap.xml会出现错误 hexojs/hexo-generator-sitemap#1

Closed

fix(permalink): use config.trailing_url.trailing_index

3de151d

stevenjoezhang mentioned this pull request Aug 31, 2019

New canonical tag helper theme-next/hexo-theme-next#1143

Merged

curbengh changed the title ~~feat(permalink): add canonical_url option to remove index.html from url~~ feat(permalink): add trailing_index option to remove index.html from url Sep 2, 2019

SukkaW mentioned this pull request Sep 11, 2019

WIP fix: use canonical url for pages hexojs/hexo-generator-sitemap#59

Closed

2 tasks

curbengh added 2 commits September 15, 2019 07:36

fix: use config.pretty_urls option

3f03a31

test: reset config and update test name

8c0ca00

yoshinorin approved these changes Sep 17, 2019

View reviewed changes

yoshinorin changed the title ~~feat(permalink): add trailing_index option to remove index.html from url~~ feat(permalink): add pretty_urls option to remove index.html from url Sep 17, 2019

SukkaW approved these changes Sep 17, 2019

View reviewed changes

curbengh merged commit ab90487 into hexojs:master Sep 18, 2019

curbengh mentioned this pull request Sep 27, 2019

docs: add pretty_urls.trailing_index option hexojs/site#1107

Merged

1 task

NoahDragon mentioned this pull request Sep 28, 2019

Hexo Roadmap #2492

Open

53 tasks

curbengh mentioned this pull request Oct 11, 2019

feat: add configs introduced in Hexo v4 hexojs/hexo-starter#23

Merged

yoshinorin mentioned this pull request Nov 13, 2019

docs(deploy): add an overview page hexojs/site#1211

Open

15 tasks

curbengh mentioned this pull request Nov 30, 2019

feat(permalink): pretty_urls.trailing_html #3893

Closed

2 tasks

SukkaW mentioned this pull request Dec 5, 2019

feat(pretty_urls): bring up hexojs/hexo-util#152

Merged

curbengh mentioned this pull request Dec 9, 2019

feat(permalink): pretty_urls.trailing_html #3917

Merged

2 tasks

curbengh deleted the canonical branch December 13, 2019 10:56

snyk-bot mentioned this pull request Mar 16, 2020

[Snyk] Upgrade hexo from 4.0.0 to 4.2.0 MichaelKohler/michaelkohler.info#14

Merged

curbengh pushed a commit to curbengh/curbengh.github.io that referenced this pull request Apr 15, 2020

chore: add pretty_urls.trailing_index config

c47368b

- hexojs/hexo#3691

Uh oh!

Conversation

curbengh commented Aug 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does it do?

How to test

Pull request tasks

Uh oh!

coveralls commented Aug 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SukkaW commented Aug 28, 2019

Uh oh!

curbengh commented Aug 28, 2019

Uh oh!

SukkaW commented Aug 28, 2019

Uh oh!

yoshinorin commented Aug 28, 2019

Uh oh!

curbengh commented Aug 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

curbengh commented Aug 30, 2019

Uh oh!

SukkaW commented Aug 30, 2019

Uh oh!

curbengh commented Aug 30, 2019

Uh oh!

curbengh commented Sep 1, 2019

Uh oh!

yoshinorin commented Sep 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

curbengh commented Sep 14, 2019

Uh oh!

SukkaW commented Sep 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoshinorin commented Sep 16, 2019

Uh oh!

curbengh commented Sep 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoshinorin left a comment

Choose a reason for hiding this comment

Uh oh!

SukkaW commented Sep 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoshinorin commented Sep 18, 2019

Uh oh!

SukkaW commented Sep 18, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

curbengh commented Aug 28, 2019 •

edited

Loading

coveralls commented Aug 28, 2019 •

edited

Loading

curbengh commented Aug 29, 2019 •

edited

Loading

yoshinorin commented Sep 14, 2019 •

edited

Loading

SukkaW commented Sep 14, 2019 •

edited

Loading

curbengh commented Sep 17, 2019 •

edited

Loading

SukkaW commented Sep 18, 2019 •

edited

Loading