Get Started
Components
Dev Tools
More Guides
Sitemaper
Sitemaper is a powerful sitemap generator designed to simplify the process of creating accurate and efficient sitemaps for websites. It crawls through your site, maps its structure, and generates an optimized sitemap, helping improve SEO and site visibility. With customizable options for depth, frequency, and output paths, Sitemaper is a versatile tool for developers and site owners aiming to keep their web presence indexed properly., Checkout Sitemaper NPM Library
✨ Features
- ⌨️ Framework Agnostic Integration.
- 🌈 Automatic Sitemap Generation.
- 🛡 Supports Large Websites.
- 🌍 Domain Specific Crawling.
- ⚙️ Customizable Crawling Depth.
- 📦 Customizable Output Path.
- 🎨 Flexible Change Frequency.
🕹 CLI Usage
Simple generation usage:
npx sitemaper generate -w https://www.nayanui.comAdvanced generation Usage:
npx sitemaper --website https://www.nayanui.com --depth 10 --output ./sitemap.xml --changefreq dailyYou can also use the shorter version of this command.
npx sitemaper -w https://www.nayanui.com -d 10 -o ./sitemap.xml -f dailyYou can also integrate Sitemaper with your localhost
npx sitemaper -w http://localhost:3000 -r https://www.nayanui.com -d 10 -o ./sitemap.xml -f dailythis case it crawl your localhost URL and replace it with replacement URL.
# Attributes
| Name | Type | Default | Details |
|---|---|---|---|
| --website / -w | string | https://www.nayanui.com | Pass website base URL to start crawling. |
| --replacer / -r | string | Pass replacement URL to replace crawled url, this will be mostly useful to crawl localhost and replace it with original URL.. | |
| --depth / -d | number | 10 | Pass depth to let the generator know how depth it need to crawl. |
| --output / -o | string | ./sitemap.xml | Pass output to let the generator know where to keep generated sitemap. |
| --changefreq / -f | string | daily | Pass change frequency to let the generator know how frequently your content change, possible options are always, hourly, daily, weekly, monthly, yearly, never. |
Sitemap validation usage:
npx sitemaper validate --output ./sitemap.xmlYou can also use the shorter version of this command.
npx sitemaper validate -o ./sitemap.xml# Attributes
| Name | Type | Default | Details |
|---|---|---|---|
| --output / -o | string | ./sitemap.xml | Pass output to let the generator know where to keep generated sitemap. |
🕹 Programmatic Usage
npm i sitemaperimport { generateSitemap, validateSitemap } from 'sitemaper';
generateSitemap('https://www.nayanui.com', '', 10, './sitemap.xml', 'daily');
validateSitemap('./sitemap.xml');🖥 Future plans
- [x] Create Sitemaper CLI tool to generate and validate sitemaps efficiently.
- [x] Create Sitemaper programmatic API's to generate and validate sitemaps efficiently.
- [ ] Support multiple sitemaps if website is bigger than certain limit.
- [ ] Create a web application to automatically generate and submit sitemaps to search engines on a schedule.