Skip to content

Commit 2d19a04

Browse files
committed
Add README section about new sitemap support
1 parent a2478e0 commit 2d19a04

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,16 @@ The `--root` option is only needed for resolving root relative urls in case you
7575

7676
Running `hyperlink path/to/index.html --canonicalroot https://deployed.website.com/ -r --internal path/to/index.html` will recursively explore the internals links of your website to ensure internal integrity. It is recommended to make this a part of your build pipeline and block on errors, since any error is very likely to be actually user facing if our page is deployed.
7777

78-
Running `hyperlink path/to/index.html --canonicalroot https://deployed.website.com/ -r path/to/index.html` will recursively explore **all** links of your website, internal and external, to ensure that you aren't linking to external resources that have been removed or are otherwiser failing. It is not recommended to block your build pipeline on a failure of external links, since they are out of your control. Run in this mode in a non-blocking way and fix the errors in the report at your leisure. It is recommended to to this regularly, since external assets can move or disappear without warning.
78+
Running `hyperlink path/to/index.html --canonicalroot https://deployed.website.com/ -r path/to/index.html` will recursively explore **all** links of your website, internal and external, to ensure that you aren't linking to external resources that have been removed or are otherwise failing. It is not recommended to block your build pipeline on a failure of external links, since they are out of your control. Run in this mode in a non-blocking way and fix the errors in the report at your leisure. It is recommended to to this regularly, since external assets can move or disappear without warning.
79+
80+
### Using a sitemap
81+
82+
Hyperlink understands sitemaps, and if you have one, it is recommended to start hyperlink out from that. You might have multiple sitemaps, annotated with `Sitemap:`-directives in your `robots.txt`, in which case you can start hyperlink from your `robots.txt` as well. Run `hyperlink path/to/robots.txt` or `hyperlink path/to/sitemap.xml`
83+
84+
The following sitemap formats are supported:
85+
- [XML Sitemap](https://en.wikipedia.org/wiki/Sitemaps#File_format)
86+
- [Text Sitemap](https://en.wikipedia.org/wiki/Sitemaps#Text_file)
87+
- [RSS or Atom syndictation feeds](https://en.wikipedia.org/wiki/Sitemaps#Syndication_feed)
7988

8089
## Reporters
8190

0 commit comments

Comments
 (0)