@sphido/sitemap 2.0.2 → 2.0.5

package/lib/sitemap.js

@@ -4,8 +4,9 @@ import {dirname} from 'node:path';
 
 /**
  * Generate XML sitemap
+ * @see https://www.sitemaps.org/protocol.html
  * @param {string} file
- * @returns {Object<{add: add, end: end}>}
+ * @return {Promise<{add({url: string, date?: Date, priority?: Number, changefreq?: string}=): void, end(): void}>}
  */
 export async function createSitemap(file = 'public/sitemap.xml') {
 	// Create directory
@@ -20,14 +21,30 @@ export async function createSitemap(file = 'public/sitemap.xml') {
 
 	// Create stream
 	const sitemap = createWriteStream(file, {flags: 'a'});
-	sitemap.write('<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n');
+	sitemap.write('<?xml version="1.0" encoding="UTF-8"?>\r\n');
+	sitemap.write('<urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9">\r\n');
 
 	return {
+		/**
+		 * Add URL to sitemap
+		 * @param {string} url
+		 * @param {Date} date
+		 * @param {Number} priority
+		 * @param {string} changefreq
+		 */
 
-		add(url, lastmod = new Date(), priority = 0.8) {
-			sitemap.write(`\t<url><loc>${url}</loc><lastmod>${lastmod.toISOString()}</lastmod><priority>${priority}</priority></url>\r\n`);
+		add({url, date = new Date(), priority = 0.5, changefreq = 'monthly'} = {}) {
+			sitemap.write('\t<url>\r\n');
+			sitemap.write(`\t\t<loc>${url}</loc>\r\n`);
+			sitemap.write(`\t\t<lastmod>${date.toISOString()}</lastmod>\r\n`);
+			sitemap.write(`\t\t<priority>${priority}</priority>\r\n`);
+			sitemap.write(`\t\t<changefreq>${changefreq}</changefreq>\r\n`);
+			sitemap.write('\t</url>\r\n');
 		},
 
+		/**
+		 * Save sitemap end
+		 */
 		end() {
 			sitemap.write('</urlset>');
 			sitemap.end();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sphido/sitemap",
-	"version": "2.0.2",
+	"version": "2.0.5",
 	"author": {
 		"name": "Roman Ožana",
 		"email": "roman@ozana.cz",
@@ -15,10 +15,11 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@sindresorhus/slugify": "^2.1.0",
-		"ava": "^4.2.0"
+		"ava": "^4.2.0",
+		"got": "^12.1.0"
 	},
 	"scripts": {
 		"test": "ava"
 	},
-	"gitHead": "df860e9742cc0228338438748f62ea9733ff0872"
+	"gitHead": "2ec312ef7e5bf2c7c34694f66d5463ae79a00cf6"
 }

package/readme.md

@@ -14,29 +14,65 @@ yarn add @sphido/sitemap
 import {dirname, relative, join} from 'node:path';
 import {getPages, allPages} from '@sphido/core';
 import slugify from '@sindresorhus/slugify';
-import {createSitemap} from '../lib/sitemap.js';
+import {createSitemap, pingSitemap} from '@sphido/sitemap';
+import got from 'got';
 
 const pages = await getPages({path: 'content'});
 const map = await createSitemap('sitemap.xml');
 
-map.add('https://sphido.org', new Date(), 1);
+map.add({url: 'https://sphido.org', priority: 1});
 
 for (const page of await allPages(pages)) {
 	page.slug = join('/', relative('content', dirname(page.path)), slugify(page.name) + '.html');
-	map.add('https://sphido.org' + page.slug, new Date());
+	map.add({
+		url: 'https://sphido.org' + page.slug,
+		date: new Date(),
+	});
 }
 
 map.end();
+
+// ping Google about new sitemap
+await got.get('https://www.google.com/webmasters/tools/ping?sitemap=https://sphido.org/sitemap.xml');
 ```
 
-## Source codes
+## Let them know
+
+### Google
+
+Google expects the standard sitemap protocol in all formats.
+Google does not currently consume the `<priority>` attribute in sitemaps.
+You can also submit RSS or Atom files.
+
+Google doesn't check a sitemap every time a site is crawled; a sitemap is checked only
+the first time that we notice it, and thereafter only when you ping us to let us know
+that it's changed. Alert Google about a sitemap only when it's new or updated;
+don't submit or ping unchanged sitemaps multiple times.
+
+You can use [got](https://github.com/sindresorhus/got) - Human-friendly and powerful HTTP request library for Node.js
+or visit [URL manually](https://www.google.com/webmasters/tools/ping?sitemap=https://sphido.org/sitemap.xml)
+
+```javascript
+import got from 'got';
+await got.get('https://www.google.com/webmasters/tools/ping?sitemap=https://sphido.org/sitemap.xml');
+```
 
-https://github.com/sphido/sphido/tree/main/packages/sphido-sitemap
 
-## TODO
+### Bing, Seznam, Yandex
 
-Ping Google about changes:
+[IndexNow](https://www.indexnow.org/) is an open-source protocol that allows website publishers to
+instantly index across participating search engines, updating results based upon the latest content changes.
+[IndexNow](https://www.indexnow.org/) protocol is supported by [Microsoft Bing](https://www.bing.com/indexnow), [Seznam.cz](https://www.seznam.cz/) and Yandex.
+
+1. **Generate an API Key** – This is submitted alongside URLs to ensure ownership of the domain. You can use [Microsoft Bing API Key generator](https://www.bing.com/indexnow).
+2. **Host API Key** – Your API key is hosted on the root directory in `txt` format.
+3. **Submit URLs with Parameters** – You can either submit URLs individually or in bulk as sitemap file.
 
 ```text
-https://www.google.com/webmasters/tools/ping?sitemap=https://www.mydomain.com/sitemap.xml
-```
+https://www.bing.com/indexnow?url=[URL]&key=[YOUR KEY]
+https://search.seznam.cz/indexnow?url=[URL]&key=[YOUR KEY]
+```
+
+## Source codes
+
+https://github.com/sphido/sphido/tree/main/packages/sphido-sitemap