Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 23fbf6ef1a | |||
| 1cffbc08c1 |
@@ -1,5 +1,11 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-03-20 - 4.0.1 - fix(readme)
|
||||
format features list as markdown bullets for proper rendering
|
||||
|
||||
- Converts the features section entries into markdown bullet list items
|
||||
- Improves README readability and consistent rendering across markdown viewers
|
||||
|
||||
## 2026-03-20 - 4.0.0 - BREAKING CHANGE(api)
|
||||
redesign smartsitemap around builder-based sitemap creation, parsing, validation, and import utilities
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@push.rocks/smartsitemap",
|
||||
"version": "4.0.0",
|
||||
"version": "4.0.1",
|
||||
"private": false,
|
||||
"description": "A comprehensive TypeScript sitemap library with builder API, supporting standard, news, image, video, and hreflang sitemaps with auto-splitting, streaming, validation, and RSS feed integration.",
|
||||
"main": "dist_ts/index.js",
|
||||
|
||||
30
readme.md
30
readme.md
@@ -14,21 +14,21 @@ pnpm install @push.rocks/smartsitemap
|
||||
|
||||
## ✨ Features
|
||||
|
||||
🔗 **Chainable Builder API** — Fluent, composable API where every method returns `this`
|
||||
📰 **News Sitemaps** — Google News-compatible with proper namespace handling
|
||||
🖼️ **Image Sitemaps** — Full `image:image` extension support
|
||||
🎬 **Video Sitemaps** — Full `video:video` extension with all fields
|
||||
🌍 **hreflang / i18n** — `xhtml:link` alternate language annotations
|
||||
📑 **Sitemap Index** — Automatic splitting at 50K URLs with index generation
|
||||
🌊 **Streaming** — Node.js Readable stream for million-URL sitemaps
|
||||
✅ **Validation** — URL validation, size limits, spec compliance checks
|
||||
📊 **Statistics** — URL counts, image/video/news counts, size estimates
|
||||
📡 **RSS/Atom Feed Import** — Convert feeds to sitemaps (unique feature!)
|
||||
📄 **YAML Config** — Declarative sitemap definition from YAML
|
||||
🗂️ **Multi-Format Output** — XML, TXT, JSON, gzipped buffer
|
||||
🎨 **XSL Stylesheets** — Browser-viewable sitemaps
|
||||
🔍 **Bidirectional Parsing** — Parse existing sitemaps back into structured data
|
||||
💪 **Full TypeScript** — Complete type safety with exported interfaces
|
||||
- 🔗 **Chainable Builder API** — Fluent, composable API where every method returns `this`
|
||||
- 📰 **News Sitemaps** — Google News-compatible with proper namespace handling
|
||||
- 🖼️ **Image Sitemaps** — Full `image:image` extension support
|
||||
- 🎬 **Video Sitemaps** — Full `video:video` extension with all fields
|
||||
- 🌍 **hreflang / i18n** — `xhtml:link` alternate language annotations
|
||||
- 📑 **Sitemap Index** — Automatic splitting at 50K URLs with index generation
|
||||
- 🌊 **Streaming** — Node.js Readable stream for million-URL sitemaps
|
||||
- ✅ **Validation** — URL validation, size limits, spec compliance checks
|
||||
- 📊 **Statistics** — URL counts, image/video/news counts, size estimates
|
||||
- 📡 **RSS/Atom Feed Import** — Convert feeds to sitemaps (unique feature!)
|
||||
- 📄 **YAML Config** — Declarative sitemap definition from YAML
|
||||
- 🗂️ **Multi-Format Output** — XML, TXT, JSON, gzipped buffer
|
||||
- 🎨 **XSL Stylesheets** — Browser-viewable sitemaps
|
||||
- 🔍 **Bidirectional Parsing** — Parse existing sitemaps back into structured data
|
||||
- 💪 **Full TypeScript** — Complete type safety with exported interfaces
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartsitemap',
|
||||
version: '4.0.0',
|
||||
version: '4.0.1',
|
||||
description: 'A comprehensive TypeScript sitemap library with builder API, supporting standard, news, image, video, and hreflang sitemaps with auto-splitting, streaming, validation, and RSS feed integration.'
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user