Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
remix-sitemap
Advanced tools
remix-sitemap - npm Package Compare versions
Comparing version 2.2.0 to 2.2.1
| { | ||
| "name": "remix-sitemap", | ||
| "version": "2.2.0", | ||
| "version": "2.2.1", | ||
| "private": false, | ||
@@ -5,0 +5,0 @@ "bin": { |
101
README.md
@@ -19,13 +19,30 @@ <h1>Remix Sitemap</h1> | ||
| ## Overview | ||
| ## ✨ Features | ||
| ### Features | ||
| - Runtime Generation | ||
| - Build time Generation (Experimental) | ||
| - Runtime & Build time Generation | ||
| - Generate `robots.txt` | ||
| - v2 Route Convention Support | ||
| - Splitting Sitemaps | ||
| ## Installation | ||
| ## 📚 Table Of Contents | ||
| - [Getting Started](#-getting-started) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [Runtime Generation](#runtime-generation) | ||
| - [Build time Generation](#build-time-generation) | ||
| - [Guides](#-guides) | ||
| - [Generate Sitemap for Dynamic Routes](#generate-sitemap-for-dynamic-routes) | ||
| - [Exclude Route](#exclude-route) | ||
| - [Google: News, Image and Video](#google-news-image-and-video) | ||
| - [Splitting Sitemaps](#splitting-sitemaps) | ||
| - [Caching](#caching) | ||
| - [API Reference](#-api-reference) | ||
| - [Config](#config) | ||
| ## 🚀 Getting Started | ||
| ### Installation | ||
| ```sh | ||
@@ -35,5 +52,5 @@ npm i remix-sitemap | ||
| ## Usage | ||
| For generate the sitemap we have 2 ways. | ||
| ### Runtime Generation | ||
| ### Usage | ||
| #### Runtime Generation | ||
| ```ts | ||
@@ -72,3 +89,3 @@ // entry.server.tsx | ||
| ``` | ||
| ### Build time Generation (Experimental) | ||
| #### Build time Generation | ||
@@ -97,25 +114,5 @@ Create a `remix-sitemap.config.js` file at the project root | ||
| ## Config | ||
| This library is a little inspired in [next-sitemap](https://www.npmjs.com/package/next-sitemap) so the config is pretty much the same | ||
| ## 📝 Guides | ||
| | Property | Description | | ||
| | ---------------------------------------------- | ------------------------------------------------------------------------------------- | | ||
| | siteUrl | Base url of your website | | ||
| | changefreq (optional) | Change frequency. Default `daily` | | ||
| | priority (optional) | Priority. Default `0.7` | | ||
| | autoLastmod (optional) | Add `<lastmod/>` property. Default `true` | | ||
| | sitemapBaseFileName (optional) | The name of the generated sitemap file before the file extension. Default `"sitemap"` | | ||
| | alternateRefs (optional) | multi language support by unique url. Default `[]` | | ||
| | outDir (optional) | The directory to create the sitemaps files. Default `"public"` | | ||
| | generateRobotsTxt (optional) | Generate `robots.txt` file. Default `false` | | ||
| | robotsTxtOptions.policies (optional) | Policies for generating `robots.txt` | | ||
| | robotsTxtOptions.additionalSitemaps (optional) | Add additionals sitemaps to `robots.txt` | | ||
| | format (optional) | Format the sitemap for better view. Default `false` | | ||
| | size (optional) | Max size of the sitemap. | | ||
| | generateIndexSitemap (optional) | Generate index sitemap. Default `true` (build time only) | | ||
| | headers (optional) | Headers for the sitemap and robots.txt response. | | ||
| | cache (optional) | Cache the sitemap. (runtime only) | | ||
| --- | ||
| ## Generate Sitemap for Dynamic Routes | ||
| ### Generate Sitemap for Dynamic Routes | ||
| > If you are using build time generation, the request will be empty | ||
@@ -149,3 +146,3 @@ ```ts | ||
| ## Exclude Route | ||
| ### Exclude Route | ||
| ```ts | ||
@@ -160,3 +157,3 @@ // app/routes/private.tsx | ||
| ## Google: News, Image and Video | ||
| ### Google: News, Image and Video | ||
| Url set can contain additional sitemaps defined by google. These are Google [news](https://developers.google.com/search/docs/crawling-indexing/sitemaps/news-sitemap), [image](https://developers.google.com/search/docs/crawling-indexing/sitemaps/image-sitemaps) or [video](https://developers.google.com/search/docs/crawling-indexing/sitemaps/video-sitemaps). | ||
@@ -178,3 +175,3 @@ You can add these sitemaps in `sitemap function` by adding the `news`, `images` or `videos` property. | ||
| ## Splitting Sitemaps | ||
| ### Splitting Sitemaps | ||
| If you have a lot of urls, you can split the sitemap in multiple files. You can do this by setting the `size` property in the config. | ||
@@ -190,3 +187,3 @@ > This is only available in build time generation | ||
| ## Caching | ||
| ### Caching | ||
| you have two ways to cache the sitemap, the first one is using the `Cache-Control` header | ||
@@ -217,6 +214,34 @@ > This is only available in runtime generation | ||
| ## Author | ||
| ## 📖 API Reference | ||
| 👤 **Fedeya <hello@fedeminaya.com>** | ||
| ### Config | ||
| - `siteUrl`: the website base url | ||
| - `autoLastmod = true`: (*optional*) Add `<lastmod />` property with the current date. | ||
| - `priority = 0.7`: (*optional*) default priority for all entries. | ||
| - `changefreq = 'daily'`: (*optional*) default changefreq for all entries. | ||
| - `format = false`: (*optional*) format the sitemap for a better view. | ||
| - `alternateRefs = []`: (*optional*) default multi language support by unique url for all entries. | ||
| - `generateRobotsTxt = false`: (*optional*) generate `robots.txt` file. | ||
| - `robotsTxtOptions`: (*optional*) options for generating `robots.txt` [details](#RobotsTxtOptions). | ||
| **Runtime only** | ||
| - `headers = {}`: (*optional*) headers for the sitemap and robots.txt response. | ||
| - `cache`: (*optional*) cache the sitemap [details](#Caching). | ||
| **Build Time only** | ||
| - `generateIndexSitemap = true`: (*optional*) generate index sitemap. | ||
| - `sitemapBaseFileName = 'sitemap'`: (*optional*) the name of the generated sitemap file before the file extension. | ||
| - `outDir = 'public'`: (*optional*) the directory to create the sitemaps files. | ||
| - `size = 50000`: (*optional*) max size of the sitemap. | ||
| #### RobotsTxtOptions | ||
| - `policies = []`: (*optional*) policies for generating `robots.txt`. | ||
| - `additionalSitemaps = []`: (*optional*) add additionals sitemaps to `robots.txt`. | ||
| ## 👤 Author | ||
| **Fedeya <hello@fedeminaya.com>** | ||
| - Website: [fedeminaya.com](https://fedeminaya.com) | ||
@@ -223,0 +248,0 @@ - Twitter: [@fedeminaya](https://twitter.com/fedeminaya) |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by11.11%
250
Worsened metrics
- Total package byte prevSize
- decreased by-0.62%
102835
No dependency changes