=== Super5 Sitemap ===
Contributors: super5bg
Tags: sitemap, html sitemap, site map, accessibility, seo
Requires at least: 6.4
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

An accessible HTML sitemap page for visitors: pages, posts and products, with no private content leaks and no JavaScript.

== Description ==

Super5 Sitemap adds a sitemap page that people can read: every published page, post and product in one place, with pages nested under their parents and posts grouped by category.

WordPress already makes an XML sitemap for search engines. This plugin makes the HTML page for visitors, and it is built to be safe, accessible and light.

= What makes it different =

* **Accessible markup.** The sitemap is a real `<nav>` landmark with a label, proper headings and nested lists, so screen-reader users can jump to it and move through it.
* **Respects your SEO plugin for free.** Anything marked "noindex" in Yoast SEO, Rank Math, SEOPress or All in One SEO is left out automatically.
* **Private content stays private.** Only published content is listed. Drafts, scheduled and private posts never appear, and password-protected content is hidden by default. The cache is only built from logged-out visits, so nothing a logged-in user can see is ever shown to the public.
* **No JavaScript on your site.** The page is plain HTML with a tiny stylesheet that loads only where the sitemap is shown. It works with strict Content Security Policies.
* **Fast on big sites.** The finished HTML is cached and cleared automatically when you publish, edit or delete content.
* **Easy switch from All in One SEO.** If AIOSEO is not active, its `[aioseo_html_sitemap]` shortcode keeps working.

= Features =

* A "Sitemap" page is created for you on activation (only if you don't have one yet).
* A "Sitemap" block for the block editor, and the `[super5_sitemap]` shortcode for any page builder.
* Choose which content types to list: pages, posts, WooCommerce products and other public post types.
* Four styles that take your theme's fonts and colours: Tree (main pages as boxes with their sub-pages hanging below, the default), Cards, Clean columns, and Classic (plain lists). Choose one in the settings, or a different one per block or shortcode.
* Group posts by category.
* Leave out any page or post by ID.
* Optional "Sitemap by Super5" credit link. It is off by default and only appears if you switch it on.

= Shortcode =

`[super5_sitemap]` uses the plugin settings. Optional attributes:

* `post_types="page,post"` lists only these content types, in this order.
* `exclude_ids="12,34"` hides these IDs, on top of the ones in the settings.
* `heading_level="3"` uses `<h3>` for section headings (2 to 5).
* `style="cards"` uses this style instead of the one in the settings: `tree`, `cards`, `columns` or `classic`.

= Privacy =

Super5 Sitemap makes no external requests, sets no cookies and collects no data.

= About =

Made by [Super5](https://super5.bg/), a web design agency in Bulgaria.

== Installation ==

1. Install and activate the plugin from Plugins → Add New.
2. A page called "Sitemap" is created and published. Add it to your footer menu.
3. Go to Settings → Super5 Sitemap to choose what it lists.

== Frequently Asked Questions ==

= Does this replace my XML sitemap? =

No. The XML sitemap is for search engines and is made by WordPress or your SEO plugin. This plugin adds the HTML page for visitors, and the two work side by side.

= Can I put the sitemap on a different page? =

Yes. Add the "Sitemap" block or the `[super5_sitemap]` shortcode to any page. You can delete the page the plugin created; it will not be created again.

= Can I change the colours? =

Every style takes its colours from your theme. To set a different accent for the count badge and the heading lines, add this to your theme's CSS: `.super5-sitemap { --super5-sitemap-accent: #0a7cff; }`

= What happens when I delete the plugin? =

Its settings and cache are removed. The sitemap page stays, because it is your content. Without the plugin it shows nothing.

= How can I report security bugs? =

Please email support@super5.bg with the details, and do not post them in the public support forum.

== Screenshots ==

1. The sitemap page as visitors see it, in the Tree style: main pages as boxes with their sub-pages below, posts grouped by category.
2. Settings → Super5 Sitemap: choose what to list, the style, what to leave out, and privacy and SEO options.
3. The Sitemap block in the block editor.

== Changelog ==

= 1.1.0 =
* New: three designed styles, Tree (the new default), Cards and Clean columns. They use your theme's fonts and colours.
* New: the 1.0 look stays available as "Classic". Pick a style under Settings → Super5 Sitemap, in the block, or with `style=""` on the shortcode.
* New: each section heading shows how many links it holds.

= 1.0.0 =
* First release.
