https://github.com/baraja-core/sitemap
Simple sitemap generator with robust and performance implementation.
https://github.com/baraja-core/sitemap
robust sitemap sitemap-generator sitemap-xml urlloader
Last synced: about 1 year ago
JSON representation
Simple sitemap generator with robust and performance implementation.
- Host: GitHub
- URL: https://github.com/baraja-core/sitemap
- Owner: baraja-core
- License: mit
- Created: 2020-09-27T17:18:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-08T13:41:10.000Z (almost 4 years ago)
- Last Synced: 2025-03-18T13:14:12.537Z (over 1 year ago)
- Topics: robust, sitemap, sitemap-generator, sitemap-xml, urlloader
- Language: PHP
- Homepage:
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sitemap generator
=================
Simple sitemap generator with robust and performance implementation.
- Generates a standardized site map in XML format,
- Allows custom implementation of UrlLoader and specification of custom link sources,
- The generated map is automatically cached and updated without the need to use cron.
📦 Installation
---------------
It's best to use [Composer](https://getcomposer.org) for installation, and you can also find the package on
[Packagist](https://packagist.org/packages/baraja-core/sitemap) and
[GitHub](https://github.com/baraja-core/sitemap).
To install, simply use the command:
```shell
$ composer require baraja-core/sitemap
```
You can use the package manually by creating an instance of the internal classes, or register a DIC extension to link the services directly to the Nette Framework.
Basic description
------------------
The package automatically generates a site map as a `sitemap.xml` file with the following structure:
```xml
https://... // Here will be the whole absolute path
weekly
0.5
```
URLs are retrieved from the abstract `SitemapUrlLoader` service, which can be overloaded and otherwise implemented. UrlLoader returns the entity field `SitemapItems[]` with the `getUrls()` method.
It adds its own presenter to the administration, which shows the current form and structure of the file.
Installation
------------
Composer:
```shel
$ composer require baraja-core/sitemap
```
The routing rule and services are registered automatically.
After installation, you must define an UrlLoader in the package, which gets a list of all available URLs and passes it on for rendering. You can use another existing library as the UrlLoader.
Getting a list of URLs
----------------------
The package does not include the default implementation of UrlLoader, and each project must implement it itself.
The class must contain a public `getUrls()` method that returns an array of `SitemapItem[]` instances.
Getting sitemap + cache
-----------------------
The package does not create any physical sitemap file, because it runs a PHP script with each request. In order not to always have to perform complex mapping, the package itself will use a cache with a default validity of 5 minutes.
The cache length setting can be affected by the `neon` configuration file:
```yaml
sitemap:
cacheExpirationTime: '20 minutes'
```
📄 License
-----------
`baraja-core/sitemap` is licensed under the MIT license. See the [LICENSE](https://github.com/baraja-core/sitemap/blob/master/LICENSE) file for more details.