push.rocks/smartsitemap
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(readme): format features list as markdown bullets for proper rendering

Browse Source
This commit is contained in:
Jürgen Kunz
2026-03-20 14:09:24 +00:00
parent 67e69f9988
commit 1cffbc08c1
3 changed files with 22 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
changelog.md
View File

@@ -1,5 +1,11 @@
# Changelog # 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) ## 2026-03-20 - 4.0.0 - BREAKING CHANGE(api)
redesign smartsitemap around builder-based sitemap creation, parsing, validation, and import utilities redesign smartsitemap around builder-based sitemap creation, parsing, validation, and import utilities

30
readme.md
View File

@@ -14,21 +14,21 @@ pnpm install @push.rocks/smartsitemap
## ✨ Features ## ✨ Features
🔗 **Chainable Builder API** — Fluent, composable API where every method returns `this` - 🔗 **Chainable Builder API** — Fluent, composable API where every method returns `this`
📰 **News Sitemaps** — Google News-compatible with proper namespace handling - 📰 **News Sitemaps** — Google News-compatible with proper namespace handling
🖼️ **Image Sitemaps** — Full `image:image` extension support - 🖼️ **Image Sitemaps** — Full `image:image` extension support
🎬 **Video Sitemaps** — Full `video:video` extension with all fields - 🎬 **Video Sitemaps** — Full `video:video` extension with all fields
🌍 **hreflang / i18n** — `xhtml:link` alternate language annotations - 🌍 **hreflang / i18n** — `xhtml:link` alternate language annotations
📑 **Sitemap Index** — Automatic splitting at 50K URLs with index generation - 📑 **Sitemap Index** — Automatic splitting at 50K URLs with index generation
🌊 **Streaming** — Node.js Readable stream for million-URL sitemaps - 🌊 **Streaming** — Node.js Readable stream for million-URL sitemaps
✅ **Validation** — URL validation, size limits, spec compliance checks - ✅ **Validation** — URL validation, size limits, spec compliance checks
📊 **Statistics** — URL counts, image/video/news counts, size estimates - 📊 **Statistics** — URL counts, image/video/news counts, size estimates
📡 **RSS/Atom Feed Import** — Convert feeds to sitemaps (unique feature!) - 📡 **RSS/Atom Feed Import** — Convert feeds to sitemaps (unique feature!)
📄 **YAML Config** — Declarative sitemap definition from YAML - 📄 **YAML Config** — Declarative sitemap definition from YAML
🗂️ **Multi-Format Output** — XML, TXT, JSON, gzipped buffer - 🗂️ **Multi-Format Output** — XML, TXT, JSON, gzipped buffer
🎨 **XSL Stylesheets** — Browser-viewable sitemaps - 🎨 **XSL Stylesheets** — Browser-viewable sitemaps
🔍 **Bidirectional Parsing** — Parse existing sitemaps back into structured data - 🔍 **Bidirectional Parsing** — Parse existing sitemaps back into structured data
💪 **Full TypeScript** — Complete type safety with exported interfaces - 💪 **Full TypeScript** — Complete type safety with exported interfaces
## Quick Start ## Quick Start

2
ts/00_commitinfo_data.ts
View File

@@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartsitemap', 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.' 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.'
} }