feat(plugin-sitemap): add sitemap plugin (close #337)

[Mister-Hope]

Close #337

[Mister-Hope]

Addtional: CI failed because of coverage, but since this plugin is deeply coupled with vuepress plugin api, it's hard to add some tests.

[meteorlxy]

Follow the same file structure as other plugins, i.e. only use node/index.ts to import/export things, and use a node/sitemapPlugin.ts file to declare the plugin

[Mister-Hope]

Got it. i will update these days!

[ramesh-dada]

@meteorlxy @Mister-Hope THANK You so much for doing great work is their any estimated release date that when this plugin will be released ?

[Mister-Hope]

I am finishing all the changes, except I remain zh jsdocs in SitemapOptions.

IMO, as we are providing both chinese and english docs, it's reasonable to keep both the languages in the final options provided to users to make sure they get full hints.

[meteorlxy]

IMO, as we are providing both chinese and english docs, it's reasonable to keep both the languages in the final options provided to users to make sure they get full hints.

Remove them, or we need to add translations to all other comments.

[maodou38]

it's happy to know that we will support support sitemap recently.And also appreciate @Mister-Hope ‘s sitemap plugin.
i will use your plugin until the official release version online

[ramesh-dada]

@Mister-Hope Before you merge this can you please take a look at this also #353

[Mister-Hope]

I would prefer not to support any of the 2 fr in #353. For my personal reason, see #353 (comment)

If you have different ideas and think any of them should be supported, just leave a message.

[maodou38]

why the pull request bog down？

[Mister-Hope]

why the pull request bog down？

I am a postgraduate student, just kind of busy in real life.

[liziwl]

Any progress on the feature of sitemap?

[KnorpelSenf]

What are the chances that this lands in the 2.0 release?

[jrcharles]

Any update here?

[Mister-Hope]

I will finish it once my winter vacation begins, just busy being a postgraduate student studying quantum physics

[Mister-Hope]

@meteorlxy Should be ready

[Mister-Hope]

Some explaination:

• A lot of plugin option has been renamed
• modifyTimeGetter is better with a Page arg, see plugin docs example
• A short description of sitemap is added.

[Zhengqbbb]

I will change the logic, only when base is / and user has a robot.txt in public folder, the plugin will try to add sitemap url to it. This should be better.

I also think this is the right design, whatever this is a sitemap plugin.
But robot.txt is spider friendly for sites that don't submit sitemaps. For documentation, it would be better to mention that robot.txt needs to be added to the publish folder.

[Zhengqbbb]

And for 1, you should set priority in frontmatter.sitemap.priority and it's injected in the speard operator I think.
Is this option problematic to you?

• But you can see that it is not mentioned in the English document, but mentioned in the one asked in Chinese.
• I think the significance of this option item is that for md files that do not declare formatter on normal pages, this is a unified source of priority. After all, everyone is not very willing to think about the priority of this page.

[Mister-Hope]

I also think this is the right design, whatever this is a sitemap plugin.
But robot.txt is spider friendly for sites that don't submit sitemaps. For documentation, it would be better to mention that robot.txt needs to be added to the publish folder.

The missing option in docs is added.

[Mister-Hope]

And for 1, you should set priority in frontmatter.sitemap.priority and it's injected in the speard operator I think.
Is this option problematic to you?

• But you can see that it is not mentioned in the English document, but mentioned in the one asked in Chinese.
• I think the significance of this option item is that for md files that do not declare formatter on normal pages, this is a unified source of priority. After all, everyone is not very willing to think about the priority of this page.

A description is added

[Mister-Hope]

@meteorlxy Could you have another check?

[Jelledb]

Looking forward to the sitemap plugin!

[JohannesRudolph]

I can confirm the sitemap plugin is working fine, pulled the code from the PR in as a "vendored" dependency and it works great for our site.

[Mister-Hope]

@meteorlxy 👀大哥有空审一下吧，不要摸鱼了🤣

（For the rest, free to ignore this, I can't catch up a translation in English for 摸鱼)

[JohannesRudolph]

One feedback, I'd like to have the option to set the changefreq option to null/undefined so that it's not part of the sitemap. Since we already have lastmod this is going to be fine for most sites and sends less confusing signals to search engine crawlers.

[hustcer]

It's really a long time to wait

[Mister-Hope]

You can use vuepress-plugin-sitemap2

[jrappen]

Any updates?

---

Also, I found this site helpful:

https://developers.google.com/search/docs/advanced/crawling/localized-versions#sitemap

[Zhengqbbb]

Any updates?

Also, I found this site helpful:

https://developers.google.com/search/docs/advanced/crawling/localized-versions#sitemap

Hey u can use vuepress-plugin-sitemap2
Demo:
https://github.com/Zhengqbbb/vuepress-plugin/blob/b5383fa7d8a548d8306f5ab49e60a4a567281874/docs/.vuepress/config.ts#L42-L45

[jrappen]

I was asking about this pull request, not about the other plugin.

[Mister-Hope]

That plugin is published by me as the same with this pr.

[jrappen]

Are you going to rebase and fix conflicts, as this is the last item on the roadmap?

[jrappen]

should be robots.txt

[jrappen]

should be robots.txt

[taozuhong]

能不能早点合入并发布稳定版本？要不 VitePress 都出来了，它的价值空间就会被严重挤压，这么多努力就白费了。
Machine translate:
Could merge and release a stable version as soon as quickly? Otherwise, VitePress will come out, its value space will be severely squeezed, and so much effort will be in vain.

[meteorlxy]

@taozuhong You can take a look at vuejs/vitepress#548

VitePress might be VuePress 3 as a decision of Vue.js Team. So VuePress 2 has already been in an awkward position. That's why the stable version delayed a lot.

[Mister-Hope]

I am updating vuepress-plugin-sitemap2 with every vp2 version, you are free to use that.

[taozuhong]

@taozuhong You can take a look at vuejs/vitepress#548

VitePress might be VuePress 3 as a decision of Vue.js Team. So VuePress 2 has already been in an awkward position. That's why the stable version delayed a lot.

Nice to see it, hope the plugins Api become more stable than last, make the plugin ecosystem release more power.

[Mister-Hope]

Closing, this will be maintained speratedly